kieraisverybored
/

fein

@@ -1,199 +1,92 @@
----
-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]

+# fein-14B 🚀
+Finetuned **Qwen 3-14B** on the *Smol-Talk Dolphin* dataset
+with LoRA adapters, then merged into a single set of full-precision weights
+for easy inference.
+| Model | Params | Base | Quant options | Checkpoints |
+|-------|--------|------|---------------|-------------|
+| `fein-14b` | 14.8 B | – (merged) | 4-bit / 8-bit | one folder, ready to load |
+---
+## Table of contents
+1. [Quick start (inference)](#quick-start-inference)
+2. [Installation](#installation)
+3. [Training](#training)
+4. [Continuing training](#continuing-training)
+5. [Merging the adapters](#merging-the-adapters)
+6. [Pushing to your HF space](#pushing-to-hub)
+7. [Repo layout](#repo-layout)
+8. [Citation](#citation)
+9. [License](#license)
+---
+## Quick start (inference)
+```bash
+git clone https://huggingface.co/kieraisverybored/fein
+cd fein
+# Optional: create & activate conda env
+conda create -n fein python=3.11 -y
+conda activate fein
+```
+Now install requirements.
+```bash
+# 4-bit streaming chat
+python infer.py --model .
+# short answers (128 tokens max)
+python infer.py --model . --max-new 128
+````
+### Sample session
+```text
+User: Hi!
+Assistant: Hello! How can I assist you today? 😊
+```
+---
+## Installation
+```bash
+# Core libs
+pip install torch>=2.2.0 transformers>=4.40.0 accelerate bitsandbytes
+# Optional quality-of-life
+pip install tqdm rich
+```
+> **GPU:** A single 24 GB card is enough for 4-bit inference.
+> **CPU:** Possible with 8-bit + `device_map="cpu"`, but sloooow.
+---
+## Citation
+```bibtex
+@misc{fein2025,
+  title       = {FEIN–14B: Smol-Talk fine-tune of Qwen 3-14B},
+  author      = {KieraDev},
+  year        = {2025},
+  howpublished= {\url{https://huggingface.co/kieraisverybored/fein}}
+}
+```
+---
+## License
+The base model inherits the **Apache License**; the finetuned weights are
+released under the same terms.
+The dataset is MIT-licensed.
+See for full details.
+---
+> *Have fun experimenting—and please open an issue if you hit a snag!* 🙌