Upload README.md with huggingface_hub

README.md

@@ -9,22 +9,19 @@ language:
 
 #  Table of Contents
 
-- [](#-model_id-)
+- [](#-model_name)
 - [Table of Contents](#table-of-contents)
-- [Model basic information](#model-basic)
-- [Technical Details](#technical-details)
-- [Training Details](#training-details)
-- [Model Evaluation](#model-evaluation)
-- [Model Examination](#model-examination)
-
-
-# Model Basic
-
+- [1. Model Basic Information](#model-basic-information)
+- [2. Technical Specifications](#technical-specifications)
+- [3. Training Details](#training-details)
+- [4. Model Evaluation](#model-evaluation)
+- [5. Model Examination](#model-examination)
 
 
+# 1. Model Basic Information
 <!--> This section provides basic information about what the model is, its current status, and where it came from.. <!-->
 - **Version:** 0
-## Intended use
+## 1.1. Intended use
 - **Treatment site ICD10:** More information needed
 - **Treatment modality:** More information needed
 - **Prescription levels [Gy]:** More information needed
@@ -33,7 +30,7 @@ language:
 - **Class:** More information needed
 - **Creation date:** 2024-07-01
 - **Type of architecture** More information needed
-## Development and deployment
+## 1.2. Development and deployment
 - **Developed by:** Name: More information needed, Instutution: More information needed, Email: More information needed
 - **Funded by:** More information needed
 - **Shared by:** More information needed
@@ -42,7 +39,7 @@ language:
 - **Related Research Paper(s):** More information needed
 - **Related Git Repository:** More information needed
 
-## How to Get Started with the Model
+## 1.3. How to Get Started with the Model
 
 Use the code below to get started with the model.
 <details>
@@ -52,155 +49,32 @@ More information needed
 
 </details>
 
-# Technical Details
-
-<!--> Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. <!-->
-
-## Direct Use
-
+# 2. Technical Specifications
+## 2.1. Model architecture
+- **Total number of parameters:** 5
+- **Input channels:** More information needed
+- **Loss function** More information needed
+- **Batch size** 1
+- **Patch dimension** More information needed
+<img width="100%" src="https://cdn-uploads.huggingface.co/production/uploads/65c9dbefd6cbf9dfed67367e/xGGUE5spRY6tar5R4VeKX.png" alt="error while loading image"> 
+_Figure 1: Model architecture_ 
+
+- **Libraries/Dependencies:** More information needed
+- **Hardware recommended:** More information needed
+- **Inference time for recommended [seconds]** 10
+
+# 3. Training Details
+- **Training set size:** 10
+- **Validation set size:** 10
+<img width="100%" src="https://cdn-uploads.huggingface.co/production/uploads/65c9dbefd6cbf9dfed67367e/xGGUE5spRY6tar5R4VeKX.png" alt="error while loading image"> 
+_Figure 2: Age distribution_ 
+<img width="100%" src="https://cdn-uploads.huggingface.co/production/uploads/65c9dbefd6cbf9dfed67367e/xGGUE5spRY6tar5R4VeKX.png" alt="error while loading image"> 
+_Figure 2: Sex distribution_ 
+
+- **Dataset source:** More information needed
+- **Acquisition date** from 2024-07-01 23:28:50.347004 to 2024-07-01 23:28:50.347004 
+# 4. Model Evaluation
+
+# 5. Model Examination
 <!--> This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. <!-->
 
-More information needed
-
-## Downstream Use [Optional]
-
-<!--> This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app <!-->
-
-More information needed
-
-## Out-of-Scope Use
-
-<!--> This section addresses misuse, malicious use, and uses that the model will not work well for. <!-->
-
-More information needed
-
-# Bias, Risks, and Limitations
-
-<!--> This section is meant to convey both technical and sociotechnical limitations. <!-->
-
-More information needed
-
-## Recommendations
-
-<!--> This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. <!-->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recomendations.
-
-# Training Details
-
-## Training Data
-
-<!--> This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. <!-->
-
-More information needed
-
-## Training Procedure
-
-<!--> This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. <!-->
-
-### Preprocessing
-
-More information needed
-
-### Speeds, Sizes, Times
-
-<!--> This section provides information about throughput, start/end time, checkpoint size if relevant, etc. <!-->
-
-More information needed
- 
-# Evaluation
-
-<!--> This section describes the evaluation protocols and provides the results. <!-->
-
-## Testing Data, Factors & Metrics
-
-### Testing Data
-
-<!--> This should link to a Data Card if possible. <!-->
-
-More information needed
-
-### Factors
-
-<!--> These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. <!-->
-
-More information needed
-
-### Metrics
-
-<!--> These are the evaluation metrics being used, ideally with a description of why. <!-->
-
-More information needed
-
-## Results 
-
-More information needed
-
-# Model Examination
-
-More information needed
-
-# Environmental Impact
-
-<!--> Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly <!-->
-
-
-
-- **Hardware Type:** More information needed
-- **Hours used:** More information needed
-- **Cloud Provider:** More information needed
-- **Compute Region:** More information needed
-- **Carbon Emitted:** More information needed
-
-# Technical Specifications [optional]
-
-## Model Architecture and Objective
-
-More information needed
-
-## Compute Infrastructure
-
-More information needed
-
-### Hardware
-
-More information needed
-
-### Software
-
-More information needed
-
-# Citation
-
-<!--> If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. <!-->
-
-**BibTeX:**
-
-More information needed
-
-**APA:**
-
-More information needed
-
-# Glossary [optional]
-
-<!--> If relevant, include terms and calculations in this section that can help readers understand the model or model card. <!-->
-
-More information needed
-
-# More Information [optional]
-
-More information needed
-
-# Model Card Authors [optional]
-
-More information needed
-
-# Model Card Contact
-
-More information needed
-
-
-
-
-