Update README.md

README.md

@@ -1,199 +1,71 @@
 ---
-library_name: transformers
-tags: []
+license: apache-2.0
+language:
+- ja
+- en
+tags:
+- japanese
+- causal-lm
+inference: false
 ---
+# CyberAgentLM3-22B-Chat (CALM3-22B-Chat)
 
-# Model Card for Model ID
+## Model Description
 
-<!-- Provide a quick summary of what the model is/does. -->
+CyberAgentLM3-22B is a decoder-only language model pre-trained on 2.0 trillion tokens from scratch.  
+CyberAgentLM3-22B-Chat is a fine-tuned model specialized for dialogue use cases.
 
+## Usage
 
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
 
-## 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. -->
+model = AutoModelForCausalLM.from_pretrained("cyberagent/calm3-22b-chat", device_map="auto", torch_dtype="auto")
+tokenizer = AutoTokenizer.from_pretrained("cyberagent/calm3-22b-chat")
+streamer = TextStreamer(tokenizer, skip_prompt=True, skip_special_tokens=True)
 
-[More Information Needed]
+messages = [
+    {"role": "system", "content": "あなたは親切なAIアシスタントです。"},
+    {"role": "user", "content": "AIによって私たちの暮らしはどのように変わりますか？"}
+]
 
-## Evaluation
+input_ids = tokenizer.apply_chat_template(messages, add_generation_prompt=True, return_tensors="pt").to(model.device)
+output_ids = model.generate(input_ids,
+                            max_new_tokens=1024,
+                            temperature=0.5,
+                            streamer=streamer)
+```
 
-<!-- This section describes the evaluation protocols and provides the results. -->
+## Prompt Format
+CALM3-22B-Chat uses ChatML as the prompt format.
+```
+<|im_start|>system
+あなたは親切なAIアシスタントです。<|im_end|>
+<|im_start|>user
+AIによって私たちの暮らしはどのように変わりますか？<|im_end|>
+<|im_start|>assistant
+```
 
-### 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]
+## Model Details
 
-[More Information Needed]
+* **Model size**: 22B
+* **Context length**: 16384
+* **Model type**: Transformer-based Language Model
+* **Language(s)**: Japanese, English
+* **Developed by**: [CyberAgent, Inc.](https://www.cyberagent.co.jp/)
+* **License**: Apache-2.0
 
-## Model Card Authors [optional]
+## Author
 
-[More Information Needed]
+[Ryosuke Ishigami](https://huggingface.co/rishigami)
 
-## Model Card Contact
+## How to cite
 
-[More Information Needed]
+```tex
+@misc{cyberagent-calm3-22b-chat,
+      title={cyberagent/calm3-22b-chat},
+      url={https://huggingface.co/cyberagent/calm3-22b-chat},
+      author={Ryosuke Ishigami},
+      year={2024},
+}
+```