hf-100
/

Jamba-1.5-mini-Spellbound-StoryWriter-0.1-6583896-ckpt81-merged

@@ -1,199 +1,69 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## 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. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### 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]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+license: other
+license_name: jamba-open-model-license
+license_link: https://www.ai21.com/licenses/jamba-open-model-license
+language:
+- en
+- fr
+- de
+- nl
+- es
+- pt
+- it
+- ar
+- he
+pipeline_tag: text-generation
+tags:
+- mamba
+- jamba
+- moe
 library_name: transformers
 ---
+# Spellbound Jamba Mini: Creative output over long contexts
+  <img src="https://i.imgur.com/IG4IKfV.png" width=500 height=500>
+# Main Goals
+### The main goals of the base model choice and post-trained regime are
+- Strong steerability
+- Coherence over long context lengths
+- Flexible writing styles
+- Advanced formatting that allows identifying individual speakers
+### There was also a secondary training objective: to teach the model to understand and produce directives in XML tags.
+- `<${characterName}Description>`: A definition of a character defined as a markdown list of details. For example:
+    - Name: Character Name
+    - Personality: Character Personality
+    - Speaker ID: 32AN4R (see `<quote>` tag below)
+    - ...
+- `<writingInstructions>`: A block of markdown formatted instructions representing what should happen in the story.
+- `<pastStory>`: A block containing the preceeding events to the story being written
+### Output can optionally include the following tags:
+- `<quote speaker="{speakerId}">`: When a character is defined with a speaker ID, the model will output the speech surrounded by `<quote speaker="{speakerId}">` and `</quote>`. The model learns to keep speech in character this way, and it allows for identifying different speakers for rendering and text-to-speech purposes
+- `<action>`: Represents an action taken by a character
+- `<sound>`: Represents a sound made in the story
+**Instructing the model to produce these tags is optional**, but the model should produce best possible output if the frontend being used can parse/ignore these
+# Post-training Details
+## Post-training consists of 1 epoch of SFT LORA training
+- Trained on synthetic instructions for strong steerability
+- Outputs rated by [tryspellbound.com](https://tryspellbound.com) beta users who opted-in
+- Lora Rank: 8
+- Batch Size: 2
+- Learning Rate: 1e-5
+# Model Creator
+Made by [tryspellbound.com](https://tryspellbound.com).
+Note: This is a continued run from the [chkpt53](https://huggingface.co/hf-100/Jamba-1.5-mini-Spellbound-StoryWriter-0.1-6583896-ckpt53-merged) version