imageomics
/

BGNN-trait-segmentation

@@ -47,59 +47,59 @@ trunk
 - **Developed by:** M. Maruf and Anuj Karpatne
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
 <!-- Provide the basic links for the model. -->
 - **Repository:** [BGNN-trait-segmentation](https://github.com/hdr-bgnn/BGNN-trait-segmentation)
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
 <!-- 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
 <!-- 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 recommendations.
 ## How to Get Started with the Model
 <!--Use the code below to get started with the model.-->
-See instructions for use [here](https://github.com/hdr-bgnn/BGNN-trait-segmentation/blob/main/Segment_mini/README.md)
 ## Training Details
@@ -138,20 +138,20 @@ We then trained the prepared model for 120 epochs, updating the weights using di
 The Adam optimizer ([Kingma & Ba, 2014](https://doi.org/10.48550/arXiv.1412.6980)) with a small learning rate (1e-4) was used to update the model weights.
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
 ## Evaluation
@@ -164,87 +164,87 @@ Our segmentation model achieved a 0.90 mIoU score on the test dataset.
 We had 99 testing images and 98 validation images.
-#### 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]
-#### Summary
-## Model Examination [optional]
 <!-- Relevant interpretability work for the model goes here -->
-[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 -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
 - **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 [optional]
 <!-- 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]
@@ -256,6 +256,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 ## Model Card Contact
-[More Information Needed]

 - **Developed by:** M. Maruf and Anuj Karpatne
+<!--- **Shared by [optional]:** [More Information Needed]-->
+<!--- **Model type:** [More Information Needed]-->
+<!--- **Language(s) (NLP):** [More Information Needed]-->
+- **License:** MIT
+<!--- **Finetuned from model [optional]:** [More Information Needed]-->
+### Model Sources
 <!-- Provide the basic links for the model. -->
 - **Repository:** [BGNN-trait-segmentation](https://github.com/hdr-bgnn/BGNN-trait-segmentation)
+- **Paper:** [In progress]
+<!--- **Demo [optional]:** [More Information Needed]-->
+<!-- ## Uses
 <!-- 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
 <!-- 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 recommendations. -->
 ## How to Get Started with the Model
 <!--Use the code below to get started with the model.-->
+See instructions for use [here](https://github.com/hdr-bgnn/BGNN-trait-segmentation/blob/main/Segment_mini/README.md).
 ## Training Details
 The Adam optimizer ([Kingma & Ba, 2014](https://doi.org/10.48550/arXiv.1412.6980)) with a small learning rate (1e-4) was used to update the model weights.
+<!-- #### Preprocessing [optional]
+<!-- [More Information Needed]
+<!-- #### Training Hyperparameters
+<!-- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+<!-- #### Speeds, Sizes, Times [optional]
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+<!-- [More Information Needed] -->
 ## Evaluation
 We had 99 testing images and 98 validation images.
+<!-- #### 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]
+<!-- #### Summary
+<!-- ## Model Examination [optional]
 <!-- Relevant interpretability work for the model goes here -->
+<!-- [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 -->
+<!-- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
 - **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 [optional]
 <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+<!-- M. Maruf, 2023, "BGNN-trait-segmentation", DOI coming with model soon for paper citation -->
+<!-- **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]
 ## Model Card Contact
+[More Information Needed] -->