nvidia
/

C-RADIO

Feature Extraction

Transformers

Safetensors

custom_code

Model card Files Files and versions Community

gheinrich commited on Dec 13, 2024

Commit

fa9358c

verified ·

1 Parent(s): 7aea24b

Update README.md

Browse files

Files changed (1) hide show

README.md +63 -181

README.md CHANGED Viewed

@@ -1,201 +1,83 @@
----
-library_name: transformers
-tags: []
----
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **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:** [More Information Needed]
-- **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.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset 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 [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
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset 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]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

+# Model Overview
+## Description:
+This model performs visual feature extraction.
+For instance, RADIO generates image embeddings that can be used by a downstream model to classify images.
+This model is for research and development only.
+### License/Terms of Use
+[License](https://developer.download.nvidia.com/licenses/nvidia-open-model-license-agreement-june-2024.pdf)
+## References:
+[Paper](https://arxiv.org/abs/2312.06709)
+## Model Architecture:
+**Architecture Type:** Neural Network  <br>
+**Network Architecture:** Vision Transformer <br>
+## Input:
+**Input Type(s):** Image <br>
+**Input Format(s):** Red, Green, Blue (RGB) <br>
+**Input Parameters:** Two Dimensional (2D) <br>
+**Other Properties Related to Input:** Image resolutions up to 2048x2028 in increments of 16 pixels <br>
+## Output:
+**Output Type(s):** Embeddings <br>
+**Output Format:** Tensor <br>
+**Output Parameters:** 2D <br>
+**Other Properties Related to Output:** Downstream model required to leverage image features <br>
+## Software Integration:
+**Runtime Engine(s):**
+* TAO- 24.10 <br>
+**Supported Hardware Microarchitecture Compatibility:** <br>
+* NVIDIA Ampere <br>
+* NVIDIA Blackwell <br>
+* NVIDIA Jetson  <br>
+* NVIDIA Hopper <br>
+* NVIDIA Lovelace <br>
+* NVIDIA Pascal <br>
+* NVIDIA Turing <br>
+* NVIDIA Volta <br>
+**[Preferred/Supported] Operating System(s):** <br>
+* Linux
+* Linux 4 Tegra
+* QNX
+* Windows
+## Model Version(s):
+C-RADIO.
+**Link:** https://huggingface.co/nvidia/C-RADIO
+# Training, Testing, and Evaluation Datasets:
+## Training Dataset:
+NV-CC-Img-Text-Dataset  <br>
+** Data Collection Method by dataset <br>
+* Automated <br>
+** Labeling Method by dataset <br>
+* Not Applicable (no labels are needed) <br>
+**Properties:** 700 Million Images <br>
+## Evaluation Dataset:
+**Link:** [ImageNet](https://www.image-net.org/)  <br>
+** Data Collection Method by dataset <br>
+* Automated <br>
+** Labeling Method by dataset <br>
+* Human <br>
+**Properties:** This dataset spans 1000 object classes and contains 1,281,167 training images, 50,000 validation images and 100,000 test images.<br>
+## Inference:
+**Engine:** PyTorch <br>
+**Test Hardware:** A100 <br>
+## Ethical Considerations (For NVIDIA Models Only):
+NVIDIA believes Trustworthy AI is a shared responsibility and we have established policies and practices to enable development for a wide array of AI applications.  When downloaded or used in accordance with our terms of service, developers should work with their internal model team to ensure this model meets requirements for the relevant industry and use case and addresses unforeseen product misuse.
+Please report security vulnerabilities or NVIDIA AI Concerns [here](https://www.nvidia.com/en-us/support/submit-security-vulnerability/).