Update README.md

README.md

@@ -1,199 +1,197 @@
 ---
+license: apache-2.0
+language:
+- ko
 library_name: transformers
-tags: []
 ---
+# Model Details
 
-# Model Card for Model ID
+![logo](https://huggingface.co/x2bee/POLAR-14B-v0.2/resolve/main/Plateer_image.png)
 
-<!-- Provide a quick summary of what the model is/does. -->
+## Model Description
 
+<!-- Provide a longer summary of what this model is/does. -->
+POLAR is a Korean LLM developed by Plateer's AI-lab. It was inspired by Upstage's SOLAR. We will continue to evolve this model and hope to contribute to the Korean LLM ecosystem.
 
+- **Developed by:** AI-Lab of Plateer(Woomun Jung, Eunsoo Ha, MinYoung Joo, Seongjun Son)
+- **Model type:** Language model
+- **Language(s) (NLP):** ko
+- **License:** apache-2.0
+- Parent Model: upstage/SOLAR-10.7B-v1.0
 
-## 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
+# 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
+## Direct Use
+```
+from transformers import AutoTokenizer, AutoModelForCausalLM
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+tokenizer = AutoTokenizer.from_pretrained("x2bee/POLAR-14B-v0.2")
+model = AutoModelForCausalLM.from_pretrained("x2bee/POLAR-14B-v0.2")
+```
 
-[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 -->
+<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info 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. -->
+<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
 
-[More Information Needed]
 
-## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+# Bias, Risks, and Limitations
 
-### Recommendations
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
 
-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
+## Recommendations
 
-Use the code below to get started with the model.
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
-[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 Details
 
-### Training Procedure
+## Training Data
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+<!-- This should link to a Data 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. -->
 
-#### Preprocessing [optional]
+More information on training data needed
 
-[More Information Needed]
 
+## Training Procedure
 
-#### Training Hyperparameters
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+### Preprocessing
 
-#### Speeds, Sizes, Times [optional]
+More information needed
 
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+### Speeds, Sizes, Times
 
-[More Information Needed]
+<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-## Evaluation
+More information needed
+ 
+# Evaluation
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
+## Testing Data, Factors & Metrics
+
+### Testing Data
 
-#### Testing Data
+<!-- This should link to a Data Card if possible. -->
 
-<!-- This should link to a Dataset Card if possible. -->
+More information needed
 
-[More Information Needed]
 
-#### Factors
+### Factors
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+More information needed
 
-#### Metrics
+### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
+More information needed
 
-#### Summary
+## Results 
 
+More information needed
 
+# Model Examination
 
-## Model Examination [optional]
+More information needed
 
-<!-- Relevant interpretability work for the model goes here -->
-
-[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).
 
-- **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]
+- **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]
+# Technical Specifications [optional]
 
-### Model Architecture and Objective
+## Model Architecture and Objective
 
-[More Information Needed]
+More information needed
 
-### Compute Infrastructure
+## Compute Infrastructure
 
-[More Information Needed]
+More information needed
 
-#### Hardware
+### Hardware
 
-[More Information Needed]
+More information needed
 
-#### Software
+### Software
 
-[More Information Needed]
+More information needed
 
-## Citation [optional]
+# Citation
 
 <!-- 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]
+More information needed
 
 **APA:**
 
-[More Information Needed]
+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]
+If you would like more information about our company, please visit the link below. 
+[tech.x2bee.com](https://tech.x2bee.com/)
 
-[More Information Needed]
 
-## Model Card Authors [optional]
+# Model Card Authors [optional]
+
+<!-- This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc. -->
+
+Woomun Jung, MinYoung Joo, Eunsu Ha, Seungjun Son
+
+# Model Card Contact
+
+More information needed
+
+# How to Get Started with the Model
+
+Use the code below to get started with the model.
 
-[More Information Needed]
+<details>
+<summary> Click to expand </summary>
 
-## Model Card Contact
+More information needed
 
-[More Information Needed]
+</details>