Update README.md

README.md

@@ -1,3 +1,252 @@
----
-license: mit
----
+---
+license: mit
+datasets:
+- imageomics/KABR-original-data
+language:
+- en
+tags:
+- biology
+- CV
+- images
+- animals
+- zebra
+- giraffe
+- behavior
+---
+
+# Model Card for X3D-KABR-Kinetics
+X3D-KABR-Kinetics is a behavior recognition 
+
+## Model Details
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+- **Developed by:** [More Information Needed]
+- **Model type:** [More Information Needed]
+- **Language(s) (NLP):** [More Information Needed]
+- **License:** [More Information Needed -- choose a license (see above notes)]
+- **Fine-tuned from model:** [More Information Needed]
+
+### Model Sources
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** [Project Repo]
+- **Paper:** [More Information Needed--optional]
+- **Demo:** [More Information Needed--encouraged]
+
+## 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.
+
+<!-- Put code here or links to files to run. Set up code blocks like this:
+```
+<code here>
+```
+-->
+
+[More Information Needed]
+
+## Training Details
+
+### Training Data
+
+<!-- This should link to a Dataset Card where possible, otherwise link to the original source with more info. 
+Provide a basic overview of the training data and 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--encouraged]
+
+
+#### 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. -->
+
+[More Information Needed]
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+<!-- This should link to a Dataset Card if possible, otherwise link to the original source with more info.
+Provide a basic overview of the test data and documentation related to any data pre-processing or additional filtering. -->
+
+[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
+
+[More Information Needed]
+
+## Model Examination
+
+<!-- [optional] Relevant interpretability work for the model goes here -->
+
+[More Information Needed]
+
+## Environmental Impact
+
+<!-- 
+It would be great to try to include this.
+
+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://doi.org/10.48550/arXiv.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 
+[More Information Needed--optional]
+
+### Model Architecture and Objective
+
+[More Information Needed]
+
+### Compute Infrastructure
+
+[More Information Needed]
+
+#### Hardware
+
+[More Information Needed: hardware requirements]
+
+#### Software
+
+[More Information Needed]
+
+## Citation
+
+<!-- If there is a paper introducing the model, the Bibtex information for that should go in this section. 
+
+See notes at top of file about selecting a license. 
+If you choose CC0: This model is dedicated to the public domain for the benefit of scientific pursuits. We ask that you cite the model and journal paper using the below citations if you make use of it in your research.
+
+-->
+
+**BibTeX:**
+
+[More Information Needed]
+<!--
+Replace "<>"s with your info:
+
+If you use our model in your work, please cite the model and associated paper.
+
+**Model**
+```
+@software{<ref_code>,
+  author = {<author1 and author2>},
+  doi = {<doi once generated>},
+  title = {<title>},
+  version = {<version#>},
+  year = {<year>},
+  url = {https://huggingface.co/imageomics/<model_name>}
+}
+```
+
+-for an associated paper:
+**Paper**
+```
+@article{<ref_code>,
+  title    = {<title>},
+  author   = {<author1 and author2>},
+  journal  = {<journal_name>},
+  year     =  <year>,
+  url      = {<DOI_URL>},
+  doi      = {<DOI>}
+}
+```
+-->
+
+
+## Acknowledgements
+
+This work was supported by the [Imageomics Institute](https://imageomics.org), which is funded by the US National Science Foundation's Harnessing the Data Revolution (HDR) program under [Award #2118240](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2118240) (Imageomics: A New Frontier of Biological Information Powered by Knowledge-Guided Machine Learning). Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.
+
+## Glossary 
+
+<!-- [optional] If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+
+## More Information 
+
+<!-- [optional] Any other relevant information that doesn't fit elsewhere. -->
+
+## Model Card Authors
+
+[More Information Needed]
+
+## Model Card Contact
+
+[More Information Needed--optional]
+<!-- Could include who to contact with questions, but this is also what the "Discussions" tab is for. -->