Update README.md

README.md

@@ -1,3 +1,63 @@
----
-license: apache-2.0
----
+---
+language: en
+license: apache-2.0
+---
+
+# Model Card: LlavaOLMoBitnet1B
+
+TODO: Fill Me in with description of the model
+
+TODO: OPTIONAL Include paper abstract
+## Paper Abstract
+
+## Model Details
+
+TODO: OPTIONAL - Any notes or warnings about the dataset
+### Note
+Please note, we only provide the model adapter and do not provide a copy of the base [yahma/llama-7b-hf](https://huggingface.co/yahma/llama-7b-hf) model or its sparsified one. Any use of this adapter requires a separate download of the base model and follow [this instruction](#sparsified-base-model) to sparse the base model.
+
+### Information
+
+- **Adapter name:** TODO
+- **Base model:** TODO
+- **Sparsity:** TODO
+- **Domain:** TODO
+- **Subnetwork version:** TODO
+TODO - Add any additional info as needed
+
+
+### Training Data
+TODO - Add info on Training data (if applicable)
+
+### Evaluation Data
+TODO - Add info on Eval Data (if applicable)
+
+## How to use
+TODO - Add clear instructions on how to use the model
+
+
+## Evaluation Results
+TODO - Add results data
+
+## Model Sources
+TODO - Add links to github or arxiv
+
+## Ethical Considerations
+
+Intel is committed to respecting human rights and avoiding causing or contributing to adverse impacts on human rights. See [Intel’s Global Human Rights Principles](https://www.intel.com/content/dam/www/central-libraries/us/en/documents/policy-human-rights.pdf). Intel’s products and software are intended only to be used in applications that do not cause or contribute to adverse impacts on human rights.
+
+| Ethical Considerations | Description | 
+| ----------- | ----------- | 
+| Data | **TODO** |
+| Human life | **TODO** | 
+| Mitigations |  **TODO**  |
+| Risks and harms |  **TODO** |
+| Use cases | - | 
+
+## Citation
+
+**TODO** Add Citation information (if applicable )
+
+## License
+
+Apache-2.0