Text Generation
Transformers
Safetensors
English
llama
text-generation-inference
trl
roleplay
conversational
Merge
chat
ItsMeDevRoland commited on
Commit
7cdc446
·
verified ·
1 Parent(s): 3140aaf

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +159 -185
README.md CHANGED
@@ -1,199 +1,173 @@
1
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  library_name: transformers
3
- tags: []
4
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
 
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
-
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
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:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
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 [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
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
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
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
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
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
- Use the code below to get started with the model.
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
- [More Information Needed]
 
188
 
189
- ## More Information [optional]
190
 
191
- [More Information Needed]
 
 
 
 
192
 
193
- ## Model Card Authors [optional]
 
194
 
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
 
198
 
199
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ base_model:
3
+ - N-Bot-Int/OpenElla-NovelWriter-8B-V2-merged
4
+ - N-Bot-Int/OpenElla-NovelWriter-8B-Magnate-merged
5
+ - akjindal53244/Llama-3.1-Storm-8B
6
+ tags:
7
+ - text-generation-inference
8
+ - transformers
9
+ - llama
10
+ - trl
11
+ - roleplay
12
+ - conversational
13
+ - merge
14
+ - chat
15
+ license: agpl-3.0
16
+ language:
17
+ - en
18
+ pipeline_tag: text-generation
19
+ datasets:
20
+ - N-Bot-Int/Iris-Uncensored-Reformat-R2
21
+ - N-Bot-Int/RP-Mixed-v1
22
+ - N-Bot-Int/Magnum-RP-Dataset-v2-PACKED
23
  library_name: transformers
 
24
  ---
25
+ <details close>
26
+ <summary><b>📢 News / Changelog (click to collapse)</b></summary>
27
+
28
+ ### NEWS AND ANNOUNCEMENTS ###
29
+ (yes i write the announcement here, i figured people wont read on the main page so i'm announcing it here! - if you want to skip.. feel free to hide this!)
30
+
31
+ ## ANNOUNCEMENTS ##
32
+
33
+ - # New Models Will Be Delayed, Halted, or Canceled Until Further Notice #
34
+ - Lightning.ai, one of the GPU hosts we use, has announced that they will no longer offer free credits starting the end of July. This means our lifeline for testing,
35
+ dataset generation, and experimentation is **OFFICIALLY CUT OFF** until we find someone or a company to donate a cluster. **NEW MODELS AIMED AT IMPROVEMENTS WILL BE
36
+ DELAYED, CANCELED, OR PUSHED BACK** as we try to do everything within Kaggle and Google Colab.
37
+ *PS: No, we are NOT rich in GPU... we're doing this for the community and our love of finetuning. This means future updates will no longer be "entirely" new
38
+ architectures or models trained on new datasets — they'll probably be mixtures of our older AI models.*
39
+
40
+ - We're running out of compute. Long story short: due to Lightning.ai removing their free tier, we're looking for alternatives to generate the datasets we need to
41
+ train future AI models. We're also still trying to find our "signature model" — the one we can call entirely ours. You've seen it from Anthracite-org, where the
42
+ moment you use their models you instantly know you've used Magnum because of its Opus-level length, or Stheno at RP, etc. We're currently trying to carve out that same kind
43
+ of identity for ourselves, but it looks like that'll be delayed while we sort out our compute :(
44
+
45
+ - # We're Restructuring!
46
+ - N-Bot-Int has operated as a company for a while now — but, much like OpenAI, we're bleeding money... well, not exactly, since we've been running on free tiers.
47
+ Still, that means calling ourselves a "company" no longer really serves a purpose, so N-Bot-Int is shifting from a company to a full-time laboratory!
48
+ Expect more open-source releases from us! (Not models — as mentioned above, we don't have the compute for that :( )
49
+
50
+ - # Compliance
51
+ - It came to our attention that *Meta* took down the base model we used for OpenElla-Novelwriter v2. We're not usually the type of lab to overreact to a single
52
+ incident, but watching that happen made something click — it wasn't just fear, it was a loss of trust in Meta and a need for real assurance going forward. That
53
+ risk isn't hypothetical anymore; we've seen it happen firsthand. Given this, and given Llama 3.1's more restrictive licensing terms, we've decided that
54
+ **THIS WILL BE THE LAST LLAMA MODEL WE FINETUNE FOR THE FORESEEABLE FUTURE**. Future models will explore **QWEN** or **GEMMA** instead — we're stepping away
55
+ from Llama bases for now, both for our own peace of mind and for legal safety. **THIS IS ALSO THE LAST TIME WE'LL USE AN ABLITERATED BASE**, for safety reasons.
56
+
57
+ - Separately, we're also moving future model releases to **AGPL-3.0 instead of Apache 2.0**. This isn't about Meta or the takedown — it's about us not wanting
58
+ companies to profit off our work without giving back to the community.
59
+ *This licensing format, actually started already, I just had to announce it incase other people aren't up to date*
60
+
61
+ - # AI Refresh and Archival
62
+ - Most, if not all, of our Llama models (except recently updated ones) will soon be archived on an upcoming org that houses all of our archived models! Archived
63
+ models are automatically set to Apache (or to the original base's license). This means OpenElla (our first model family), MiniMaid, and the rest will be archived soon!
64
+
65
+ ## THAT'S ALL THE NEWS WE HAVE FOR JULY!
66
+ We're sorry to say we'll no longer be releasing on a monthly schedule — running finetunes while keeping the lights on is NOT cheap, so we're no longer rushing for
67
+ monthly releases until we find an alternative, sponsor, or cluster. We're currently in firefighting mode.
68
+
69
+ ## Support us! ##
70
+ Through **Ko-fi**: https://ko-fi.com/J3J61D8NHV
71
+ If you have any questions, feel free to email us at: nexulon.botworkinteractives@gmail.com
72
+ </details>
73
+
74
+
75
+ # OpenElla-NovelWriter-Requiem is OFFICIALLY RELEASED!
76
+ ![image (1)](https://cdn-uploads.huggingface.co/production/uploads/6633a73004501e16e7896b86/Uhu71Pfo_0cQQ2joz8DMv.jpeg)
77
+ - Thanks Grok!
78
+
79
+ (DETAILS REMAIN THE SAME... EXCEPT WITHOUT THE DARE TIES WITH V1! I WILL UPDATE THIS MODEL CARD WHEN I RECEIVE REQUEST! FOR NOW, SINCE THIS IS NOT THE MAIN VARIANT THERE
80
+ WILL BE NO UPDATE... FEEL FREE TO REQUEST FOR A MODEL CARD UPDATE AS YOU PLEASE!)
81
+
82
+ # OpenElla-NovelWriter-Requiem-Ascended — quite possibly our best Llama model yet *(yeah yeah, entirely subjective... let us have our OpenAI moment, just this once.)*
83
+
84
+ - Introducing OpenElla-NovelWriter Requiem Model! Requiem, based on the latin word *(that links to our announcement)*, is our brand new ai model that
85
+ showcases a new RP capabilities compared to our older generation of NovelWriters. Requiem Ascended is our first ai model that is finally sensitive to
86
+ character cards, Has a unique blend of creativity freedom on all types of Roleplay, and Expanded capabilities trained on llama!
87
+
88
+ - Compared to previous NovelWriters, Older novelwriters suffer from our **blarbing** sickness, where the ai model spat out the entire chat, without stopping and
89
+ waiting for user's prompt, This final version of NovelWriter, named Requiem is the **TYPE A** of the family, A final **type B** is to be released to let **YOU** choose
90
+ which of the final two are the best Requiem model!
91
+
92
+ - Both Requiem Ascended and Requiem(TypeB) models are capable of RP, whilst also solving the Old NovelWriter family's issue of **spatting out dialogues, and God modding**
93
+ Alongside it, the Requieum Ascended model has better stability when it comes to prompt following, better writing and dataset variety thanks to our DARE TIES strategy,
94
+ of which we mixed all our ai models that learned from different varied dataset to form this Masterpiece!
95
+
96
+ *READ MORE FOR MORE INFO*
97
+ 8 BILLIONS PARAMS MODEL
98
+
99
+ # OpenElla-NovelWriter-Requiem-Ascended Procedure/Methodology:
100
+ - **OpenElla Requiem Ascended** is our brand new ai model, it uses **DARE TIES** as a final methodology, however before forming the ai model, we trained the V3
101
+ of OpenElla-NovelWriter, taking the V2 and finetuning it with our new magnum synthetic dataset, this dataset contains a wide variety of data which we failed
102
+ to properly balance, leading to V3 being biased to certain hemisphere of RP and developing a concerning bias to specific instances of "scenarios". This is why
103
+ We failed to release V3 for final release which is named "OpenElla-NovelWriter-8B-Magnate"... Magnate were almost deleted however we decided to not waste
104
+ the training credits we used(since this is the final time we'll get the credits from lightning.ai) and decided to combine them with all of the NovelWriter family.
105
+ Below are the composition of each Requiem model:
106
+
107
+ - **Requiem-Ascended**: Trained with V3 + V2 + BASE, = V3.2 => V3.2 + V1 = RA
108
+ - **Requiem**: Trained with V3 + V2 + BASE = RE
109
+
110
+ The Base model we used, came from "akjindal53244/Llama-3.1-Storm-8B" as a stabilizer for this fusion, meanwhile both V3 and V2 were given a balanced weight and
111
+ density to ensure the base model inherits the specialization of the two model and a final V1 is added for noise and enhancement. This is why we seperate the two
112
+ family because we're not sure if some people would love the Ascended version or the Requiem, as both ai model has a different flavor of how they performs!
113
+
114
+ **Feel free to decide which is the best for you!**
115
+
116
+ # Training Details
117
+ - **Finetuning Tool:** MERGEKIT
118
+ - **Training Platform:** Kaggle Free Tier with T4 x2!
119
+
120
+ - **OpenElla-NovelWriter-Requiem-Ascended** is Our Brand New Powerful Model, If you ever encountered any issue, Want to commission us, or have any suggestions, please email us directly through
121
+ [nexulon.botworkinteractives@gmail.com](mailto:nexulon.botworkinteractives@gmail.com)
122
+ we value any reports, suggestions to how we improve future Model,
123
+ Once again feel free to finetune the model to your likings, However please consider Adding this Page
124
+ for **CREDITS**
125
+
126
+ - Please handle the AI with Care and ethical considerations, when **FINETUNING** this AI model, due to its **UNCENSORED** Nature.
127
+ - We are not responsible for what this model generates. Use it responsibly and legally. You downloaded it, you own what you do with it.
128
 
129
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
130
 
131
+ ## Activation Steering
132
 
133
+ An obedience steering vector is available at `obedience_vector.pt`.
134
+ Apply at `layers.23.mlp` with `strength=1.5` (recommended range: 1.0–2.5).
135
+ Improves character card compliance, author note following, and suppresses
136
+ narrator takeover / OOC breaks.
137
 
138
+ # What's Coming Next?
139
 
140
+ > 🔒 **Requiem Base to be released soon! - Supporters on KO-FI receives the model early as usual!**
141
+ ---
142
 
143
+ # Notices & Usage Tips
144
 
145
+ - **Use Llama 3 format** — the model is based on Llama 3, Soooooo using Llama 3 works best!.
146
+ - **Calibrate per character card** — every character is different, adjust your prompt, Model's settings(ie, temps, Top-K etc.) accordingly.
147
+ - **OUR SUGGESTIONS ESPECIALLY FOR KOBOLD USERS!**
148
+ - Use DynaTemp for a better experience, drop the Min-Temp to 0.50, Max-temp to 1.50, on DRY set the MULT to 0.3 and Shift the Repeat Pen if you want to
149
+ boost V3's influence......... somehow... dont ask why... but the ai model starts to act weird as you shift the repeat pen higher :|
150
 
151
+ - Format Llama 3 as mentioned above! sometimes the ai model includes [Author notes], it just depends on the character cards. Simply modify the character cards
152
+ or include an author note to prevent or stop the ai from using the "[author notes] or OOC stuffs"
153
 
154
+ (Tho then again... we are bad at giving advices... just use whatever works to ya and comment what you've used so others can use the ai model xDDDDDD)
155
 
156
+ - Chat Completion preset uploaded by PaperMache - [Preset](https://huggingface.co/PaperMache/NBotIntModelsPresets/resolve/main/NovelWriter-Requiem-Ascended-Preset.json)
157
+ ---
158
 
159
+ # About
160
+ - **OpenElla-NovelWriter-Requiem-Ascended** is
161
+ - **Developed by:** N-Bot-Int
162
+ - **License:** agpl 3.0
163
+ - **Finetuned from model :** N-Bot-Int/OpenElla-NovelWriter-merged, N-Bot-Int/OpenElla-NovelWriter-V2, N-Bot-Int/OpenElla-NovelWriter-Magnate, akjindal53244/Llama-3.1-Storm-8B
164
+
165
+ - # Detail card:
166
+ - Parameter
167
+ - 8 Billion Parameters
168
+ - (Please check your GPU Core, VRAM, CPU and RAM to see if you can comfortably run 8B models)
169
+
170
+ - Finetuning tool:
171
+ - MERGEKIT
172
+ - Fine-tuned Using:
173
+ - Kaggle Free Tier with T4 x2