P0x0 commited on
Commit
4c91e68
1 Parent(s): e383d16

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -165
README.md CHANGED
@@ -4,197 +4,69 @@ base_model:
4
  - meta-llama/Llama-3.1-8B
5
  ---
6
 
7
- # Model Card for Model ID
8
-
9
- <!-- Provide a quick summary of what the model is/does. -->
10
 
 
11
 
 
12
 
13
  ## Model Details
14
 
15
  ### Model Description
16
 
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
20
 
21
- - **Developed by:** [More Information Needed]
22
- - **Funded by [optional]:** [More Information Needed]
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Model type:** [More Information Needed]
25
- - **Language(s) (NLP):** [More Information Needed]
26
- - **License:** [More Information Needed]
27
- - **Finetuned from model [optional]:** [More Information Needed]
28
 
29
- ### Model Sources [optional]
30
 
31
- <!-- Provide the basic links for the model. -->
 
32
 
33
- - **Repository:** [More Information Needed]
34
- - **Paper [optional]:** [More Information Needed]
35
- - **Demo [optional]:** [More Information Needed]
36
 
37
  ## Uses
38
 
39
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
40
-
41
  ### Direct Use
42
 
43
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
44
-
45
- [More Information Needed]
46
-
47
- ### Downstream Use [optional]
48
-
49
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
50
-
51
- [More Information Needed]
52
 
53
  ### Out-of-Scope Use
54
 
55
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
56
-
57
- [More Information Needed]
58
 
59
- ## Bias, Risks, and Limitations
60
-
61
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
-
63
- [More Information Needed]
64
-
65
- ### Recommendations
66
-
67
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
-
69
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
 
71
  ## How to Get Started with the Model
72
 
73
- Use the code below to get started with the model.
74
-
75
- [More Information Needed]
76
-
77
- ## Training Details
78
-
79
- ### Training Data
80
-
81
- <!-- 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. -->
82
-
83
- [More Information Needed]
84
-
85
- ### Training Procedure
86
-
87
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
88
-
89
- #### Preprocessing [optional]
90
-
91
- [More Information Needed]
92
-
93
-
94
- #### Training Hyperparameters
95
-
96
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
97
-
98
- #### Speeds, Sizes, Times [optional]
99
-
100
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
101
-
102
- [More Information Needed]
103
-
104
- ## Evaluation
105
-
106
- <!-- This section describes the evaluation protocols and provides the results. -->
107
-
108
- ### Testing Data, Factors & Metrics
109
-
110
- #### Testing Data
111
-
112
- <!-- This should link to a Dataset Card if possible. -->
113
-
114
- [More Information Needed]
115
-
116
- #### Factors
117
-
118
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Metrics
123
-
124
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
125
-
126
- [More Information Needed]
127
-
128
- ### Results
129
-
130
- [More Information Needed]
131
-
132
- #### Summary
133
-
134
-
135
-
136
- ## Model Examination [optional]
137
-
138
- <!-- Relevant interpretability work for the model goes here -->
139
-
140
- [More Information Needed]
141
-
142
- ## Environmental Impact
143
-
144
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
145
-
146
- 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).
147
-
148
- - **Hardware Type:** [More Information Needed]
149
- - **Hours used:** [More Information Needed]
150
- - **Cloud Provider:** [More Information Needed]
151
- - **Compute Region:** [More Information Needed]
152
- - **Carbon Emitted:** [More Information Needed]
153
-
154
- ## Technical Specifications [optional]
155
-
156
- ### Model Architecture and Objective
157
-
158
- [More Information Needed]
159
-
160
- ### Compute Infrastructure
161
-
162
- [More Information Needed]
163
-
164
- #### Hardware
165
-
166
- [More Information Needed]
167
-
168
- #### Software
169
-
170
- [More Information Needed]
171
-
172
- ## Citation [optional]
173
-
174
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
175
-
176
- **BibTeX:**
177
-
178
- [More Information Needed]
179
-
180
- **APA:**
181
-
182
- [More Information Needed]
183
-
184
- ## Glossary [optional]
185
-
186
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
187
-
188
- [More Information Needed]
189
 
190
- ## More Information [optional]
 
 
 
 
191
 
192
- [More Information Needed]
193
 
194
- ## Model Card Authors [optional]
 
195
 
196
- [More Information Needed]
 
197
 
198
- ## Model Card Contact
 
 
199
 
200
- [More Information Needed]
 
4
  - meta-llama/Llama-3.1-8B
5
  ---
6
 
7
+ # Epos-8B
 
 
8
 
9
+ Epos-8B is a fine-tuned version of the base model **Llama-3.1-8B** from Meta, optimized for storytelling, dialogue generation, and creative writing. The model specializes in generating rich narratives, immersive prose, and dynamic character interactions, making it ideal for creative tasks.
10
 
11
+ ---
12
 
13
  ## Model Details
14
 
15
  ### Model Description
16
 
17
+ Epos-8B is an 8 billion parameter language model fine-tuned for storytelling and narrative tasks. Inspired by the grandeur of epic tales, it is designed to produce high-quality, engaging content that evokes the depth and imagination of ancient myths and modern storytelling traditions.
 
 
18
 
19
+ - **Developed by:** P0x0
20
+ - **Funded by:** [More Information Needed]
21
+ - **Shared by:** P0x0
22
+ - **Model type:** Transformer-based Language Model
23
+ - **Language(s) (NLP):** Primarily English
24
+ - **License:** Apache 2.0
25
+ - **Finetuned from model:** [meta-llama/Llama-3.1-8B](https://huggingface.co/meta-llama/Llama-3.1-8B)
26
 
27
+ ### Model Sources
28
 
29
+ - **Repository:** [Epos-8B on Hugging Face](https://huggingface.co/P0x0/Epos-8B)
30
+ - **GGUF Variant Repository:** [Epos-8B-GGUF](https://huggingface.co/P0x0/Epos-8B-GGUF)
31
 
32
+ ---
 
 
33
 
34
  ## Uses
35
 
 
 
36
  ### Direct Use
37
 
38
+ Epos-8B is ideal for:
39
+ - **Storytelling:** Generate detailed, immersive, and engaging narratives.
40
+ - **Dialogue Creation:** Create realistic and dynamic character interactions for stories or games.
41
+ - **Descriptive Writing:** Generate vivid descriptions for settings, objects, or events.
42
+ - **Creative Content Generation:** Assist writers and creators in brainstorming and drafting ideas.
 
 
 
 
43
 
44
  ### Out-of-Scope Use
45
 
46
+ Epos-8B is not recommended for real-time decision-making, safety-critical applications, or generating harmful, biased, or inappropriate content. It is designed specifically for creative writing and narrative tasks.
 
 
47
 
48
+ ---
 
 
 
 
 
 
 
 
 
 
49
 
50
  ## How to Get Started with the Model
51
 
52
+ To run the quantized version of the model, you can use [KoboldCPP](https://github.com/LostRuins/koboldcpp), which allows you to run quantized GGUF models locally.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
53
 
54
+ ### Steps:
55
+ 1. Download [KoboldCPP](https://github.com/LostRuins/koboldcpp).
56
+ 2. Follow the setup instructions provided in the repository.
57
+ 3. Download the GGUF variant of Epos-8B from [Epos-8B-GGUF](https://huggingface.co/P0x0/Epos-8B-GGUF).
58
+ 4. Load the model in KoboldCPP and start generating!
59
 
60
+ Alternatively, integrate the model directly into your code with the following snippet:
61
 
62
+ ```python
63
+ from transformers import AutoModelForCausalLM, AutoTokenizer
64
 
65
+ tokenizer = AutoTokenizer.from_pretrained("P0x0/Epos-8B")
66
+ model = AutoModelForCausalLM.from_pretrained("P0x0/Epos-8B")
67
 
68
+ input_text = "Once upon a time in a distant land..."
69
+ inputs = tokenizer(input_text, return_tensors="pt")
70
+ outputs = model.generate(**inputs)
71
 
72
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))