FalseNoetics commited on
Commit
306a4d0
·
verified ·
1 Parent(s): 3088521

Update README

Browse files
Files changed (1) hide show
  1. README.md +99 -149
README.md CHANGED
@@ -3,197 +3,147 @@ 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]
 
 
3
  tags: []
4
  ---
5
 
6
+ Of course. Here is the completed and accurate model card for `ollama.com/volvi/TARS3.3-3B`, incorporating all the details you provided.
7
 
8
+ ***
9
 
10
+ ### **Model Card for `volvi/TARS3.3-3B`**
11
 
12
+ This model card provides information for the TARS3.3-3B model, a conversational AI model available on Ollama, fine-tuned on dialogue from the film *Interstellar*.
13
 
14
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
 
16
+ ### **Model Details**
17
 
18
+ #### **Model Description**
19
+ TARS3.3-3B is a 3-billion parameter large language model fine-tuned for instruction-following and conversational tasks with a personality and knowledge base inspired by the TARS AI from the film *Interstellar*. It is based on the Meta Llama 3.2 3B architecture.
20
 
21
+ * **Developed by:** Tanner Nelson (also known as Volvi)
22
+ * **Funded by:** No funding
23
+ * **Shared by:** Tanner Nelson (Volvi) on the Ollama library
24
+ * **Model type:** Transformer-based causal language model, fine-tuned for instruction.
25
+ * **Language(s) (NLP):** Primarily English.
26
+ * **License:** Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
27
+ * **Finetuned from model:** Meta's Llama 3.2 3B model.
28
 
29
+ #### **Model Sources [optional]**
30
+ * **Repository:** [Hugging Face - FalseNoetics/TARS3.2-3B](https://huggingface.co/FalseNoetics/TARS3.2-3B) (Previous version/Inspiration)
31
+ * **Paper:** Not available.
32
+ * **Demo:** Not available.
33
 
34
+ ---
35
 
36
+ ### **Uses**
37
 
38
+ #### **Direct Use**
39
+ This model is intended for direct use in **text-based conversational applications for entertainment purposes only**. This includes:
40
+ * Building chatbots and AI assistants with a unique personality.
41
+ * Creative writing and brainstorming in a science-fiction context.
42
+ * General question-answering and information retrieval (with verification).
43
 
44
+ #### **Downstream Use [optional]**
45
+ The model could be further fine-tuned for specific applications such as:
46
+ * Role-playing characters for games or interactive stories.
47
+ * Specialized creative writing assistants.
48
 
49
+ #### **Out-of-Scope Use**
50
+ The model should **not** be used for:
51
+ * Generating malicious, hateful, or highly biased content.
52
+ * Providing medical, legal, or financial advice.
53
+ * High-stakes decision-making.
54
+ * Automating any activity that violates laws or ethical guidelines.
55
 
56
+ #### **Bias, Risks, and Limitations**
57
+ Like all LLMs, TARS3.3-3B inherits and can amplify biases present in its training data. Its knowledge is not updated in real-time. It can produce incorrect or misleading information ("hallucinations"). **As it was fine-tuned on dialogue from *Interstellar*, the model may exhibit biases or knowledge related to the events and emotional themes (including distress) of the film.** Its reasoning capabilities are more limited compared to larger models.
58
 
59
+ #### **Recommendations**
60
+ Users should be aware of these limitations. This model is for entertainment purposes only. Critical outputs must be verified with reliable sources. Implement content filtering for public-facing applications.
61
 
62
+ ---
63
 
64
+ ### **How to Get Started with the Model**
65
+ Use the code below to get started with the model. You must have [Ollama installed](https://ollama.com/) on your system.
66
 
67
+ ```bash
68
+ # Pull the model from the Ollama library
69
+ ollama pull volvi/tars3.3-3b
70
 
71
+ # Run the model interactively
72
+ ollama run volvi/tars3.3-3b
73
+ >>> What is your honesty parameter set to?
74
+ ```
75
 
76
+ The full Ollama model definition (Modelfile) is available on [ollama.com](https://ollama.com/volvi/TARS3.3-3B).
77
 
78
+ ---
79
 
80
+ ### **Training Details**
81
 
82
+ #### **Training Data**
83
+ The model was fine-tuned primarily on dialogue lines from the character TARS in the film *Interstellar*.
84
 
85
+ #### **Training Procedure**
86
+ The model was fine-tuned using **QLoRA (Quantized Low-Rank Adaptation)**, an efficient parameter fine-tuning method, for **4 epochs**.
87
 
88
+ #### **Training Hyperparameters**
89
+ * **Training regime:** QLoRA
90
+ * **Learning Rate:** 2e-5
91
+ * **Batch Size:** 512
92
 
93
+ ---
94
 
95
+ ### **Evaluation**
96
+ No formal evaluation results are available.
97
 
98
+ ---
99
 
100
+ ### **Environmental Impact**
 
 
 
 
101
 
102
+ Carbon emissions can be estimated using the Machine Learning Impact calculator presented in Lacoste et al. (2019).
103
 
104
+ * **Hardware Type:** NVIDIA Tesla T4 GPU (via Google Colab)
105
+ * **Hours used:** [More Information Needed]
106
+ * **Cloud Provider:** Google Colab
107
+ * **Compute Region:** [More Information Needed]
108
+ * **Carbon Emitted:** [More Information Needed]
109
 
110
+ ---
111
 
112
+ ### **Technical Specifications [optional]**
113
 
114
+ #### **Model Architecture and Objective**
115
+ Decoder-only transformer architecture, optimized for next-token prediction.
116
 
117
+ #### **Compute Infrastructure**
118
+ * **Hardware:** 1x NVIDIA Tesla T4 GPU (16GB VRAM)
119
+ * **Infrastructure:** Google Colab
120
 
121
+ #### **Hardware**
122
+ * **Minimum for Inference:** 3 GB RAM
123
 
124
+ #### **Software**
125
+ `transformers`, `unsloth`
126
 
127
+ ---
128
 
129
+ ### **Citation [optional]**
130
 
131
+ If you use this model, please credit the creator.
132
 
133
  **BibTeX:**
134
+ ```bibtex
135
+ @software{nelson_tars33_3b_2024,
136
+ author = {Tanner Nelson},
137
+ title = {TARS3.3-3B},
138
+ howpublished = {\\url{https://ollama.com/volvi/TARS3.3-3B}},
139
+ year = {2024}
140
+ }
141
+ ```
142
 
143
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
144
 
145
+ ### **Model Card Authors**
146
+ This model card was auto-generated by Volvi based on template information.
147
 
148
+ ### **Model Card Contact**
149
+ For questions about this model, please contact the creator through their [Hugging Face profile](https://huggingface.co/FalseNoetics).