Improve language tag

#1
by lbourdois - opened
Files changed (1) hide show
  1. README.md +111 -102
README.md CHANGED
@@ -1,102 +1,111 @@
1
-
2
- ---
3
-
4
- license: apache-2.0
5
- language:
6
- - en
7
- pipeline_tag: text-generation
8
- tags:
9
- - role-play
10
- - fine-tuned
11
- - qwen2.5
12
- base_model:
13
- - Qwen/Qwen2.5-14B-Instruct
14
- library_name: transformers
15
-
16
- ---
17
-
18
- [![QuantFactory Banner](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeiuCm7c8lEwEJuRey9kiVZsRn2W-b4pWlu3-X534V3YmVuVc2ZL-NXg2RkzSOOS2JXGHutDuyyNAUtdJI65jGTo8jT9Y99tMi4H4MqL44Uc5QKG77B0d6-JfIkZHFaUA71-RtjyYZWVIhqsNZcx8-OMaA?key=xt3VSDoCbmTY7o-cwwOFwQ)](https://hf.co/QuantFactory)
19
-
20
-
21
- # QuantFactory/oxy-1-small-GGUF
22
- This is quantized version of [oxyapi/oxy-1-small](https://huggingface.co/oxyapi/oxy-1-small) created using llama.cpp
23
-
24
- # Original Model Card
25
-
26
-
27
- ![Oxy 1 Small](https://cdn-uploads.huggingface.co/production/uploads/64fb80c8bb362cbf2ff96c7e/tTIVIblPUbTYnlvHQQjXB.png)
28
-
29
- ## Introduction
30
-
31
- **Oxy 1 Small** is a fine-tuned version of the [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen/Qwen2.5-14B-Instruct) language model, specialized for **role-play** scenarios. Despite its small size, it delivers impressive performance in generating engaging dialogues and interactive storytelling.
32
-
33
- Developed by **Oxygen (oxyapi)**, with contributions from **TornadoSoftwares**, Oxy 1 Small aims to provide an accessible and efficient language model for creative and immersive role-play experiences.
34
-
35
- ## Model Details
36
-
37
- - **Model Name**: Oxy 1 Small
38
- - **Model ID**: [oxyapi/oxy-1-small](https://huggingface.co/oxyapi/oxy-1-small)
39
- - **Base Model**: [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2.5-14B-Instruct)
40
- - **Model Type**: Chat Completions
41
- - **Prompt Format**: ChatML
42
- - **License**: Apache-2.0
43
- - **Language**: English
44
- - **Tokenizer**: [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2.5-14B-Instruct)
45
- - **Max Input Tokens**: 32,768
46
- - **Max Output Tokens**: 8,192
47
-
48
- ### Features
49
-
50
- - **Fine-tuned for Role-Play**: Specially trained to generate dynamic and contextually rich role-play dialogues.
51
- - **Efficient**: Compact model size allows for faster inference and reduced computational resources.
52
- - **Parameter Support**:
53
- - `temperature`
54
- - `top_p`
55
- - `top_k`
56
- - `frequency_penalty`
57
- - `presence_penalty`
58
- - `max_tokens`
59
-
60
- ### Metadata
61
-
62
- - **Owned by**: Oxygen (oxyapi)
63
- - **Contributors**: TornadoSoftwares
64
- - **Description**: A Qwen/Qwen2.5-14B-Instruct fine-tune for role-play trained on custom datasets
65
-
66
- ## Usage
67
-
68
- To utilize Oxy 1 Small for text generation in role-play scenarios, you can load the model using the Hugging Face Transformers library:
69
-
70
- ```python
71
- from transformers import AutoModelForCausalLM, AutoTokenizer
72
-
73
- tokenizer = AutoTokenizer.from_pretrained("oxyapi/oxy-1-small")
74
- model = AutoModelForCausalLM.from_pretrained("oxyapi/oxy-1-small")
75
-
76
- prompt = "You are a wise old wizard in a mystical land. A traveler approaches you seeking advice."
77
- inputs = tokenizer(prompt, return_tensors="pt")
78
- outputs = model.generate(**inputs, max_length=500)
79
- response = tokenizer.decode(outputs[0], skip_special_tokens=True)
80
- print(response)
81
- ```
82
-
83
- ## Performance
84
-
85
- Performance benchmarks for Oxy 1 Small are not available at this time. Future updates may include detailed evaluations on relevant datasets.
86
-
87
- ## License
88
-
89
- This model is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
90
-
91
- ## Citation
92
-
93
- If you find Oxy 1 Small useful in your research or applications, please cite it as:
94
-
95
- ```
96
- @misc{oxy1small2024,
97
- title={Oxy 1 Small: A Fine-Tuned Qwen2.5-14B-Instruct Model for Role-Play},
98
- author={Oxygen (oxyapi)},
99
- year={2024},
100
- howpublished={\url{https://huggingface.co/oxyapi/oxy-1-small}},
101
- }
102
- ```
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ language:
4
+ - zho
5
+ - eng
6
+ - fra
7
+ - spa
8
+ - por
9
+ - deu
10
+ - ita
11
+ - rus
12
+ - jpn
13
+ - kor
14
+ - vie
15
+ - tha
16
+ - ara
17
+ pipeline_tag: text-generation
18
+ tags:
19
+ - role-play
20
+ - fine-tuned
21
+ - qwen2.5
22
+ base_model:
23
+ - Qwen/Qwen2.5-14B-Instruct
24
+ library_name: transformers
25
+ ---
26
+
27
+ [![QuantFactory Banner](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeiuCm7c8lEwEJuRey9kiVZsRn2W-b4pWlu3-X534V3YmVuVc2ZL-NXg2RkzSOOS2JXGHutDuyyNAUtdJI65jGTo8jT9Y99tMi4H4MqL44Uc5QKG77B0d6-JfIkZHFaUA71-RtjyYZWVIhqsNZcx8-OMaA?key=xt3VSDoCbmTY7o-cwwOFwQ)](https://hf.co/QuantFactory)
28
+
29
+
30
+ # QuantFactory/oxy-1-small-GGUF
31
+ This is quantized version of [oxyapi/oxy-1-small](https://huggingface.co/oxyapi/oxy-1-small) created using llama.cpp
32
+
33
+ # Original Model Card
34
+
35
+
36
+ ![Oxy 1 Small](https://cdn-uploads.huggingface.co/production/uploads/64fb80c8bb362cbf2ff96c7e/tTIVIblPUbTYnlvHQQjXB.png)
37
+
38
+ ## Introduction
39
+
40
+ **Oxy 1 Small** is a fine-tuned version of the [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen/Qwen2.5-14B-Instruct) language model, specialized for **role-play** scenarios. Despite its small size, it delivers impressive performance in generating engaging dialogues and interactive storytelling.
41
+
42
+ Developed by **Oxygen (oxyapi)**, with contributions from **TornadoSoftwares**, Oxy 1 Small aims to provide an accessible and efficient language model for creative and immersive role-play experiences.
43
+
44
+ ## Model Details
45
+
46
+ - **Model Name**: Oxy 1 Small
47
+ - **Model ID**: [oxyapi/oxy-1-small](https://huggingface.co/oxyapi/oxy-1-small)
48
+ - **Base Model**: [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2.5-14B-Instruct)
49
+ - **Model Type**: Chat Completions
50
+ - **Prompt Format**: ChatML
51
+ - **License**: Apache-2.0
52
+ - **Language**: English
53
+ - **Tokenizer**: [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2.5-14B-Instruct)
54
+ - **Max Input Tokens**: 32,768
55
+ - **Max Output Tokens**: 8,192
56
+
57
+ ### Features
58
+
59
+ - **Fine-tuned for Role-Play**: Specially trained to generate dynamic and contextually rich role-play dialogues.
60
+ - **Efficient**: Compact model size allows for faster inference and reduced computational resources.
61
+ - **Parameter Support**:
62
+ - `temperature`
63
+ - `top_p`
64
+ - `top_k`
65
+ - `frequency_penalty`
66
+ - `presence_penalty`
67
+ - `max_tokens`
68
+
69
+ ### Metadata
70
+
71
+ - **Owned by**: Oxygen (oxyapi)
72
+ - **Contributors**: TornadoSoftwares
73
+ - **Description**: A Qwen/Qwen2.5-14B-Instruct fine-tune for role-play trained on custom datasets
74
+
75
+ ## Usage
76
+
77
+ To utilize Oxy 1 Small for text generation in role-play scenarios, you can load the model using the Hugging Face Transformers library:
78
+
79
+ ```python
80
+ from transformers import AutoModelForCausalLM, AutoTokenizer
81
+
82
+ tokenizer = AutoTokenizer.from_pretrained("oxyapi/oxy-1-small")
83
+ model = AutoModelForCausalLM.from_pretrained("oxyapi/oxy-1-small")
84
+
85
+ prompt = "You are a wise old wizard in a mystical land. A traveler approaches you seeking advice."
86
+ inputs = tokenizer(prompt, return_tensors="pt")
87
+ outputs = model.generate(**inputs, max_length=500)
88
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
89
+ print(response)
90
+ ```
91
+
92
+ ## Performance
93
+
94
+ Performance benchmarks for Oxy 1 Small are not available at this time. Future updates may include detailed evaluations on relevant datasets.
95
+
96
+ ## License
97
+
98
+ This model is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
99
+
100
+ ## Citation
101
+
102
+ If you find Oxy 1 Small useful in your research or applications, please cite it as:
103
+
104
+ ```
105
+ @misc{oxy1small2024,
106
+ title={Oxy 1 Small: A Fine-Tuned Qwen2.5-14B-Instruct Model for Role-Play},
107
+ author={Oxygen (oxyapi)},
108
+ year={2024},
109
+ howpublished={\url{https://huggingface.co/oxyapi/oxy-1-small}},
110
+ }
111
+ ```