John4Blues commited on
Commit
c54a1ba
1 Parent(s): 6d23977

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -118
README.md CHANGED
@@ -8,33 +8,17 @@ tags: []
8
  <!-- Provide a quick summary of what the model is/does. -->
9
  A LORA fine tuned version of Llama 3 8B instruct that is meant to serve you as a outlet to your negative thoughts
10
 
11
-
12
- ### Model Description
13
-
14
- <!-- Provide a longer summary of what this model is. -->
15
-
16
 
17
 
18
- - **Developed by:** John4Blues (Alt account for 9Skies)
19
- - **Model type:** Lora Finetuned LLM
20
- - **Finetuned from model [optional]:** Meta Llama 3 8B instruct
21
 
22
  ### Model Sources
23
 
24
  <!-- Provide the basic links for the model. -->
25
 
26
  - **Repository:** https://huggingface.co/John4Blues/Llama-3-8B-Therapy
27
- - **Demo [optional]:** https://huggingface.co/spaces/John4Blues/Therapy_Llama_3_8B
28
-
29
- ## Uses
30
-
31
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
32
-
33
- ### Direct Use
34
-
35
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
36
-
37
- [More Information Needed]
38
 
39
 
40
 
@@ -54,127 +38,41 @@ Use the code below to get started with the model.
54
 
55
  [More Information Needed]
56
 
 
 
 
57
  ## Training Details
58
 
59
  ### Training Data
60
 
61
  <!-- 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. -->
62
 
63
- [More Information Needed]
 
 
 
 
64
 
65
  ### Training Procedure
66
 
67
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
68
 
69
- #### Preprocessing [optional]
70
 
71
- [More Information Needed]
72
 
73
 
74
  #### Training Hyperparameters
75
 
76
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
77
-
78
- #### Speeds, Sizes, Times [optional]
79
-
80
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
81
 
82
- [More Information Needed]
83
-
84
- ## Evaluation
85
-
86
- <!-- This section describes the evaluation protocols and provides the results. -->
87
-
88
- ### Testing Data, Factors & Metrics
89
-
90
- #### Testing Data
91
-
92
- <!-- This should link to a Dataset Card if possible. -->
93
-
94
- [More Information Needed]
95
-
96
- #### Factors
97
-
98
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
99
-
100
- [More Information Needed]
101
-
102
- #### Metrics
103
-
104
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
105
-
106
- [More Information Needed]
107
-
108
- ### Results
109
-
110
- [More Information Needed]
111
-
112
- #### Summary
113
-
114
-
115
-
116
- ## Model Examination [optional]
117
-
118
- <!-- Relevant interpretability work for the model goes here -->
119
-
120
- [More Information Needed]
121
-
122
- ## Environmental Impact
123
-
124
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
125
-
126
- 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).
127
-
128
- - **Hardware Type:** [More Information Needed]
129
- - **Hours used:** [More Information Needed]
130
- - **Cloud Provider:** [More Information Needed]
131
- - **Compute Region:** [More Information Needed]
132
- - **Carbon Emitted:** [More Information Needed]
133
-
134
- ## Technical Specifications [optional]
135
-
136
- ### Model Architecture and Objective
137
-
138
- [More Information Needed]
139
-
140
- ### Compute Infrastructure
141
-
142
- [More Information Needed]
143
-
144
- #### Hardware
145
 
146
- [More Information Needed]
147
-
148
- #### Software
149
-
150
- [More Information Needed]
151
-
152
- ## Citation [optional]
153
-
154
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
155
-
156
- **BibTeX:**
157
-
158
- [More Information Needed]
159
-
160
- **APA:**
161
 
162
- [More Information Needed]
163
-
164
- ## Glossary [optional]
165
-
166
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
167
-
168
- [More Information Needed]
169
 
170
- ## More Information [optional]
171
 
172
- [More Information Needed]
173
-
174
- ## Model Card Authors [optional]
175
 
176
- [More Information Needed]
177
 
178
- ## Model Card Contact
179
 
180
- [More Information Needed]
 
8
  <!-- Provide a quick summary of what the model is/does. -->
9
  A LORA fine tuned version of Llama 3 8B instruct that is meant to serve you as a outlet to your negative thoughts
10
 
11
+ - **Developed by:** John4Blues (Alt account for 9Skies)
12
+ - **Finetuned from model:** https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct
 
 
 
13
 
14
 
 
 
 
15
 
16
  ### Model Sources
17
 
18
  <!-- Provide the basic links for the model. -->
19
 
20
  - **Repository:** https://huggingface.co/John4Blues/Llama-3-8B-Therapy
21
+ - **Demo:** https://huggingface.co/spaces/John4Blues/Therapy_Llama_3_8B
 
 
 
 
 
 
 
 
 
 
22
 
23
 
24
 
 
38
 
39
  [More Information Needed]
40
 
41
+
42
+
43
+
44
  ## Training Details
45
 
46
  ### Training Data
47
 
48
  <!-- 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. -->
49
 
50
+ dataset card example
51
+ dataset card example
52
+ dataset card example
53
+
54
+
55
 
56
  ### Training Procedure
57
 
58
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
59
 
60
+ google colab jupyter notebook:
61
 
 
62
 
63
 
64
  #### Training Hyperparameters
65
 
 
 
 
 
66
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
67
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
 
69
+ hyperstufff
 
 
 
 
 
 
 
 
 
 
 
 
 
 
70
 
 
 
 
 
 
 
 
71
 
 
72
 
73
+ ## Evaluation
 
 
74
 
75
+ <!-- This section describes the evaluation protocols and provides the results. -->
76
 
 
77
 
78
+ (results of stuff)