Update README.md
Browse files
README.md
CHANGED
@@ -1,199 +1,77 @@
|
|
1 |
---
|
2 |
-
library_name: transformers
|
3 |
-
|
|
|
|
|
|
|
|
|
|
|
4 |
---
|
5 |
|
6 |
-
# Model Card for
|
7 |
-
|
8 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
9 |
-
|
10 |
|
|
|
11 |
|
12 |
## Model Details
|
13 |
|
14 |
### Model Description
|
15 |
|
16 |
-
|
17 |
-
|
18 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
19 |
|
20 |
-
- **Developed by:**
|
21 |
-
- **
|
22 |
-
- **
|
23 |
-
- **Model type:** [More Information Needed]
|
24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
25 |
-
- **License:** [More Information Needed]
|
26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
27 |
|
28 |
-
### Model Sources
|
29 |
|
30 |
-
|
31 |
-
|
32 |
-
- **Repository:** [More Information Needed]
|
33 |
-
- **Paper [optional]:** [More Information Needed]
|
34 |
-
- **Demo [optional]:** [More Information Needed]
|
35 |
|
36 |
## Uses
|
37 |
|
38 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
39 |
-
|
40 |
### Direct Use
|
41 |
|
42 |
-
|
43 |
|
44 |
-
|
45 |
|
46 |
-
|
47 |
-
|
48 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
49 |
-
|
50 |
-
[More Information Needed]
|
51 |
|
52 |
### Out-of-Scope Use
|
53 |
|
54 |
-
|
55 |
-
|
56 |
-
[More Information Needed]
|
57 |
|
58 |
## Bias, Risks, and Limitations
|
59 |
|
60 |
-
|
61 |
-
|
62 |
-
[More Information Needed]
|
63 |
|
64 |
### Recommendations
|
65 |
|
66 |
-
|
67 |
-
|
68 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
69 |
|
70 |
## How to Get Started with the Model
|
71 |
|
72 |
-
|
73 |
-
|
74 |
-
[More Information Needed]
|
75 |
-
|
76 |
-
## Training Details
|
77 |
-
|
78 |
-
### Training Data
|
79 |
-
|
80 |
-
<!-- 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. -->
|
81 |
-
|
82 |
-
[More Information Needed]
|
83 |
-
|
84 |
-
### Training Procedure
|
85 |
-
|
86 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
87 |
-
|
88 |
-
#### Preprocessing [optional]
|
89 |
-
|
90 |
-
[More Information Needed]
|
91 |
-
|
92 |
-
|
93 |
-
#### Training Hyperparameters
|
94 |
-
|
95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
96 |
-
|
97 |
-
#### Speeds, Sizes, Times [optional]
|
98 |
-
|
99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
100 |
-
|
101 |
-
[More Information Needed]
|
102 |
-
|
103 |
-
## Evaluation
|
104 |
-
|
105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
106 |
-
|
107 |
-
### Testing Data, Factors & Metrics
|
108 |
-
|
109 |
-
#### Testing Data
|
110 |
-
|
111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
112 |
-
|
113 |
-
[More Information Needed]
|
114 |
-
|
115 |
-
#### Factors
|
116 |
-
|
117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
118 |
-
|
119 |
-
[More Information Needed]
|
120 |
-
|
121 |
-
#### Metrics
|
122 |
-
|
123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
124 |
-
|
125 |
-
[More Information Needed]
|
126 |
-
|
127 |
-
### Results
|
128 |
-
|
129 |
-
[More Information Needed]
|
130 |
-
|
131 |
-
#### Summary
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
## Model Examination [optional]
|
136 |
-
|
137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
138 |
-
|
139 |
-
[More Information Needed]
|
140 |
-
|
141 |
-
## Environmental Impact
|
142 |
-
|
143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
144 |
-
|
145 |
-
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).
|
146 |
-
|
147 |
-
- **Hardware Type:** [More Information Needed]
|
148 |
-
- **Hours used:** [More Information Needed]
|
149 |
-
- **Cloud Provider:** [More Information Needed]
|
150 |
-
- **Compute Region:** [More Information Needed]
|
151 |
-
- **Carbon Emitted:** [More Information Needed]
|
152 |
-
|
153 |
-
## Technical Specifications [optional]
|
154 |
-
|
155 |
-
### Model Architecture and Objective
|
156 |
-
|
157 |
-
[More Information Needed]
|
158 |
-
|
159 |
-
### Compute Infrastructure
|
160 |
-
|
161 |
-
[More Information Needed]
|
162 |
-
|
163 |
-
#### Hardware
|
164 |
-
|
165 |
-
[More Information Needed]
|
166 |
-
|
167 |
-
#### Software
|
168 |
-
|
169 |
-
[More Information Needed]
|
170 |
-
|
171 |
-
## Citation [optional]
|
172 |
-
|
173 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
174 |
-
|
175 |
-
**BibTeX:**
|
176 |
-
|
177 |
-
[More Information Needed]
|
178 |
-
|
179 |
-
**APA:**
|
180 |
-
|
181 |
-
[More Information Needed]
|
182 |
-
|
183 |
-
## Glossary [optional]
|
184 |
-
|
185 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
186 |
|
187 |
-
|
|
|
|
|
188 |
|
189 |
-
|
|
|
|
|
190 |
|
191 |
-
|
|
|
192 |
|
193 |
-
|
|
|
194 |
|
195 |
-
|
|
|
196 |
|
197 |
-
|
|
|
198 |
|
199 |
-
|
|
|
|
|
|
1 |
---
|
2 |
+
library_name: transformers
|
3 |
+
license: mit
|
4 |
+
language:
|
5 |
+
- en
|
6 |
+
- ko
|
7 |
+
base_model:
|
8 |
+
- google/gemma-2-9b-it
|
9 |
---
|
10 |
|
11 |
+
# Model Card for Gemma-2-9b-it-Ko-Crypto-Translate
|
|
|
|
|
|
|
12 |
|
13 |
+
This model has been fine-tuned on a crypto news translation task. It is designed to translate English crypto news into Korean, leveraging the Gemma-2-9b-it architecture. The model is intended for natural language processing (NLP) tasks, specifically translation, within the crypto news domain.
|
14 |
|
15 |
## Model Details
|
16 |
|
17 |
### Model Description
|
18 |
|
19 |
+
This fine-tuned model is based on the **Gemma-2-9b-it** architecture and has been specifically trained to translate English crypto news into Korean. Fine-tuning was performed using a custom dataset focused on cryptocurrency news articles, ensuring the model's output is accurate in both language translation and crypto-specific terminology.
|
|
|
|
|
20 |
|
21 |
+
- **Developed by:** Hyoun Jun Lee
|
22 |
+
- **Model type:** Gemma-2-9b-it
|
23 |
+
- **Language(s) (NLP):** English, Korean
|
|
|
|
|
|
|
|
|
24 |
|
25 |
+
### Model Sources
|
26 |
|
27 |
+
- **Repository:** [Hugging Face: koalajun/Gemma-2-9b-it-Ko-Crypto-Translate](https://huggingface.co/koalajun/Gemma-2-9b-it-Ko-Crypto-Translate)
|
|
|
|
|
|
|
|
|
28 |
|
29 |
## Uses
|
30 |
|
|
|
|
|
31 |
### Direct Use
|
32 |
|
33 |
+
This model can be used for translating English cryptocurrency news articles into Korean. It can be integrated into applications such as financial platforms or news websites to provide real-time translation of crypto news.
|
34 |
|
35 |
+
### Downstream Use
|
36 |
|
37 |
+
The model can be further fine-tuned for more specific translation tasks in the financial or legal domains. Additionally, it can be used as a basis for other translation or language generation tasks that require bilingual capabilities in English and Korean.
|
|
|
|
|
|
|
|
|
38 |
|
39 |
### Out-of-Scope Use
|
40 |
|
41 |
+
This model is not intended for general translation tasks outside the financial/crypto domain. It may not perform well in non-financial contexts, as it was fine-tuned with specialized crypto-related datasets.
|
|
|
|
|
42 |
|
43 |
## Bias, Risks, and Limitations
|
44 |
|
45 |
+
Given the specific nature of the dataset (crypto news), the model may introduce biases related to the financial or crypto sector. The translation might also be less effective for general or non-financial text, and there could be inaccuracies in domain-specific terms.
|
|
|
|
|
46 |
|
47 |
### Recommendations
|
48 |
|
49 |
+
Users should validate the model's output in critical applications, especially when used in real-time financial decision-making or for publications where accuracy is paramount.
|
|
|
|
|
50 |
|
51 |
## How to Get Started with the Model
|
52 |
|
53 |
+
To use this model for inference, you can load it using the Hugging Face `transformers` library as follows:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
54 |
|
55 |
+
```python
|
56 |
+
from transformers import AutoModelForCausalLM, AutoTokenizer
|
57 |
+
import torch
|
58 |
|
59 |
+
model_name = "koalajun/Gemma-2-9b-it-Ko-Crypto-Translate"
|
60 |
+
model = AutoModelForCausalLM.from_pretrained(model_name)
|
61 |
+
tokenizer = AutoTokenizer.from_pretrained(model_name)
|
62 |
|
63 |
+
device = "cuda" if torch.cuda.is_available() else "cpu"
|
64 |
+
model = model.to(device)
|
65 |
|
66 |
+
# Define the input prompt for testing
|
67 |
+
prompt = "Translate the latest crypto news from English to Korean: Bitcoin prices continue to rise, surpassing $30,000 this week."
|
68 |
|
69 |
+
# Tokenize the input prompt
|
70 |
+
inputs = tokenizer(prompt, return_tensors="pt").to(device)
|
71 |
|
72 |
+
# Generate response from the model
|
73 |
+
outputs = model.generate(inputs.input_ids, max_length=200, num_return_sequences=1)
|
74 |
|
75 |
+
# Decode and print the generated text (translation)
|
76 |
+
response = tokenizer.decode(outputs[0], skip_special_tokens=True)
|
77 |
+
print("Translation:", response)
|