Update README.md
Browse files
README.md
CHANGED
@@ -3,201 +3,82 @@ library_name: transformers
|
|
3 |
tags:
|
4 |
- trl
|
5 |
- sft
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
6 |
---
|
7 |
|
8 |
-
# Model Card for Model
|
9 |
-
|
10 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
11 |
|
|
|
12 |
|
|
|
13 |
|
14 |
## Model Details
|
15 |
|
16 |
-
|
17 |
-
|
18 |
-
|
|
|
|
|
19 |
|
20 |
-
|
21 |
-
|
22 |
-
- **Developed by:** [More Information Needed]
|
23 |
-
- **Funded by [optional]:** [More Information Needed]
|
24 |
-
- **Shared by [optional]:** [More Information Needed]
|
25 |
-
- **Model type:** [More Information Needed]
|
26 |
-
- **Language(s) (NLP):** [More Information Needed]
|
27 |
-
- **License:** [More Information Needed]
|
28 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
29 |
|
30 |
-
|
31 |
|
32 |
-
|
|
|
33 |
|
34 |
-
|
35 |
-
- **Paper [optional]:** [More Information Needed]
|
36 |
-
- **Demo [optional]:** [More Information Needed]
|
37 |
|
38 |
## Uses
|
39 |
|
40 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
41 |
-
|
42 |
### Direct Use
|
43 |
-
|
44 |
-
|
45 |
-
|
46 |
-
[More Information Needed]
|
47 |
-
|
48 |
-
### Downstream Use [optional]
|
49 |
-
|
50 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
51 |
-
|
52 |
-
[More Information Needed]
|
53 |
|
54 |
### Out-of-Scope Use
|
|
|
|
|
55 |
|
56 |
-
|
57 |
-
|
58 |
-
[More Information Needed]
|
59 |
-
|
60 |
-
## Bias, Risks, and Limitations
|
61 |
-
|
62 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
63 |
-
|
64 |
-
[More Information Needed]
|
65 |
-
|
66 |
-
### Recommendations
|
67 |
-
|
68 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
69 |
-
|
70 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
71 |
-
|
72 |
-
## How to Get Started with the Model
|
73 |
-
|
74 |
-
Use the code below to get started with the model.
|
75 |
-
|
76 |
-
[More Information Needed]
|
77 |
|
78 |
## Training Details
|
79 |
|
80 |
-
### Training
|
81 |
-
|
82 |
-
|
83 |
-
|
84 |
-
|
85 |
-
|
86 |
-
|
87 |
-
|
88 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
89 |
-
|
90 |
-
#### Preprocessing [optional]
|
91 |
-
|
92 |
-
[More Information Needed]
|
93 |
-
|
94 |
|
95 |
-
|
|
|
|
|
96 |
|
97 |
-
|
98 |
-
|
99 |
-
#### Speeds, Sizes, Times [optional]
|
100 |
-
|
101 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
102 |
-
|
103 |
-
[More Information Needed]
|
104 |
|
105 |
## Evaluation
|
106 |
|
107 |
-
|
108 |
-
|
109 |
-
### Testing Data, Factors & Metrics
|
110 |
-
|
111 |
-
#### Testing Data
|
112 |
-
|
113 |
-
<!-- This should link to a Dataset Card if possible. -->
|
114 |
-
|
115 |
-
[More Information Needed]
|
116 |
-
|
117 |
-
#### Factors
|
118 |
|
119 |
-
|
120 |
-
|
121 |
-
[More Information Needed]
|
122 |
-
|
123 |
-
#### Metrics
|
124 |
-
|
125 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
126 |
-
|
127 |
-
[More Information Needed]
|
128 |
-
|
129 |
-
### Results
|
130 |
-
|
131 |
-
[More Information Needed]
|
132 |
-
|
133 |
-
#### Summary
|
134 |
-
|
135 |
-
|
136 |
-
|
137 |
-
## Model Examination [optional]
|
138 |
-
|
139 |
-
<!-- Relevant interpretability work for the model goes here -->
|
140 |
-
|
141 |
-
[More Information Needed]
|
142 |
-
|
143 |
-
## Environmental Impact
|
144 |
-
|
145 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
146 |
-
|
147 |
-
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).
|
148 |
-
|
149 |
-
- **Hardware Type:** [More Information Needed]
|
150 |
-
- **Hours used:** [More Information Needed]
|
151 |
-
- **Cloud Provider:** [More Information Needed]
|
152 |
-
- **Compute Region:** [More Information Needed]
|
153 |
-
- **Carbon Emitted:** [More Information Needed]
|
154 |
-
|
155 |
-
## Technical Specifications [optional]
|
156 |
-
|
157 |
-
### Model Architecture and Objective
|
158 |
-
|
159 |
-
[More Information Needed]
|
160 |
-
|
161 |
-
### Compute Infrastructure
|
162 |
-
|
163 |
-
[More Information Needed]
|
164 |
-
|
165 |
-
#### Hardware
|
166 |
-
|
167 |
-
[More Information Needed]
|
168 |
-
|
169 |
-
#### Software
|
170 |
-
|
171 |
-
[More Information Needed]
|
172 |
-
|
173 |
-
## Citation [optional]
|
174 |
-
|
175 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
176 |
-
|
177 |
-
**BibTeX:**
|
178 |
-
|
179 |
-
[More Information Needed]
|
180 |
-
|
181 |
-
**APA:**
|
182 |
-
|
183 |
-
[More Information Needed]
|
184 |
-
|
185 |
-
## Glossary [optional]
|
186 |
-
|
187 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
188 |
-
|
189 |
-
[More Information Needed]
|
190 |
-
|
191 |
-
## More Information [optional]
|
192 |
-
|
193 |
-
[More Information Needed]
|
194 |
-
|
195 |
-
## Model Card Authors [optional]
|
196 |
-
|
197 |
-
[More Information Needed]
|
198 |
|
199 |
-
##
|
200 |
|
201 |
-
|
|
|
202 |
|
|
|
203 |
|
|
|
|
|
|
|
|
3 |
tags:
|
4 |
- trl
|
5 |
- sft
|
6 |
+
- qna
|
7 |
+
- jordan-belfort
|
8 |
+
- sales
|
9 |
+
- mindset
|
10 |
+
- persuasion
|
11 |
+
base_model:
|
12 |
+
- openchat/openchat_3.5
|
13 |
+
pipeline_tag: text-generation
|
14 |
---
|
15 |
|
16 |
+
# Model Card for Jordan Belfort Q&A Model
|
|
|
|
|
17 |
|
18 |
+
This model is a fine-tuned version of a transformer-based language model trained using supervised fine-tuning (SFT) on a custom Q&A dataset derived from Jordan Belfort's book. The model is optimized to answer questions related to the book's content, including topics like sales, persuasion, mindset, and personal development strategies.
|
19 |
|
20 |
+
---
|
21 |
|
22 |
## Model Details
|
23 |
|
24 |
+
- **Developed by:** Jobix.ai
|
25 |
+
- **Finetuned from model:** `openchat 3.5*
|
26 |
+
- **Language(s):** English
|
27 |
+
- **Model type:** Q&A / Instruction-following
|
28 |
+
- **License:** apache-2.0 *(or your chosen license)*
|
29 |
|
30 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
31 |
|
32 |
+
## Model Sources
|
33 |
|
34 |
+
- **Training Data:** Custom Q&A dataset built from the full content of Jordan Belfort’s book.
|
35 |
+
- **Method:** Supervised fine-tuning (TRL + SFT)
|
36 |
|
37 |
+
---
|
|
|
|
|
38 |
|
39 |
## Uses
|
40 |
|
|
|
|
|
41 |
### Direct Use
|
42 |
+
- Ask specific questions about concepts, strategies, and advice in Jordan Belfort's book.
|
43 |
+
- Get summaries of chapters, sales techniques, or mindset frameworks presented in the book.
|
44 |
+
- Useful for salespeople, coaches, or individuals studying persuasion and personal development.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
45 |
|
46 |
### Out-of-Scope Use
|
47 |
+
- Not trained for general-purpose Q&A outside the context of the book.
|
48 |
+
- Not suitable for legal, financial, or medical advice.
|
49 |
|
50 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
51 |
|
52 |
## Training Details
|
53 |
|
54 |
+
### Training Procedure
|
55 |
+
- **Trainer:** `trl.SFTTrainer`
|
56 |
+
- **Precision:** bfloat16
|
57 |
+
- **Epochs:** 7
|
58 |
+
- **Optimizer:** AdamW
|
59 |
+
- **LR Scheduler:** Cosine with warmup
|
60 |
+
- **Loss:** CrossEntropyLoss on prompt-response pairs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
61 |
|
62 |
+
### Dataset
|
63 |
+
- Approx. ~2,000 curated Q&A pairs covering all chapters and sections of the book.
|
64 |
+
- Balanced across concepts like tonality, straight-line persuasion, mindset, sales process, and personal stories.
|
65 |
|
66 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
67 |
|
68 |
## Evaluation
|
69 |
|
70 |
+
- Manual evaluation on question coverage and accuracy.
|
71 |
+
- Model shows strong performance in recalling specific ideas and quoting relevant sections.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
72 |
|
73 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
74 |
|
75 |
+
## Example Usage
|
76 |
|
77 |
+
```python
|
78 |
+
from transformers import pipeline
|
79 |
|
80 |
+
qa = pipeline("text-generation", model="your-username/jordan-belfort-qa")
|
81 |
|
82 |
+
prompt = "What is the straight-line sales method according to Jordan Belfort?"
|
83 |
+
response = qa(prompt, max_new_tokens=200, do_sample=False)
|
84 |
+
print(response[0]["generated_text"])
|