Update README.md

README.md

@@ -1,6 +1,8 @@
 ---
 library_name: transformers
-tags: []
+license: cc-by-4.0
+language:
+- vsn
 ---
 
 # Model Card for Model ID
@@ -17,49 +19,52 @@ tags: []
 
 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]
+- **Developed by:** [Yuzuki Tsukagoshi](https://github.com/Yuzki)
+<!-- - **Funded by [optional]:** [More Information Needed] -->
+<!-- - **Shared by [optional]:** [More Information Needed] -->
+- **Model type:** RoBERTa, MLM
+- **Language(s) (NLP):** Vedic Sanskrit
+- **License:** CC-BY-4.0
+<!-- - **Finetuned from model [optional]:** [More Information Needed] -->
 
-### Model Sources [optional]
+### Model Sources
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [GitHub](https://github.com/Yuzki/vedic) (will be public)
+- **Paper [optional]:** (Prepairing)
+<!-- - **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. -->
+This model is for Vedic Sanskrit.
+Supported texts are transliterated into Latin characters according to [ISO 15919](https://www.iso.org/standard/28333.html)
 
 ### Direct Use
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+The model needs fine-tuning.
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Downstream Use [optional]
+<!-- ### 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]
+<!-- [More Information Needed]
 
-### Out-of-Scope Use
+### Out-of-Scope Use -->
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Bias, Risks, and Limitations
+<!-- ## Bias, Risks, and Limitations -->
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 ### Recommendations
 
@@ -67,11 +72,11 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 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
+<!-- ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+[More Information Needed] -->
 
 ## Training Details
 
@@ -132,25 +137,25 @@ Use the code below to get started with the model.
 
 
 
-## Model Examination [optional]
+<!-- ## Model Examination [optional]
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
+[More Information Needed] -->
 
-## Environmental Impact
+<!-- ## 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).
+<!-- 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]
+- **Carbon Emitted:** [More Information Needed] -->
 
-## Technical Specifications [optional]
+<!-- ## Technical Specifications [optional]
 
 ### Model Architecture and Objective
 
@@ -166,7 +171,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 #### Software
 
-[More Information Needed]
+[More Information Needed] -->
 
 ## Citation [optional]
 
@@ -180,20 +185,20 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-## Glossary [optional]
+<!-- ## 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 Needed] -->
 
-## More Information [optional]
+<!-- ## More Information [optional]
 
-[More Information Needed]
+[More Information Needed] --> -->
 
-## Model Card Authors [optional]
+<!-- ## Model Card Authors [optional]
 
-[More Information Needed]
+[More Information Needed] -->
 
-## Model Card Contact
+<!-- ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed] -->