Update README.md
Browse files
README.md
CHANGED
@@ -1,69 +1,85 @@
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
-
tags:
|
|
|
|
|
|
|
|
|
|
|
4 |
---
|
5 |
|
6 |
-
#
|
7 |
|
8 |
-
|
9 |
|
|
|
|
|
|
|
10 |
|
11 |
|
12 |
## Model Details
|
13 |
|
14 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
15 |
|
16 |
-
|
17 |
|
18 |
-
This is
|
19 |
|
20 |
-
- **Developed by:** [
|
21 |
-
- **Funded by
|
22 |
-
- **Shared by
|
23 |
-
- **Model type:** [
|
24 |
-
- **Language(s) (NLP):** [
|
25 |
-
- **License:** [
|
26 |
-
- **Finetuned from model [optional]:** [
|
27 |
|
28 |
### Model Sources [optional]
|
29 |
|
30 |
<!-- Provide the basic links for the model. -->
|
31 |
|
32 |
-
- **Repository:** [
|
33 |
-
- **Paper [
|
34 |
-
- **Demo [
|
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 |
-
|
43 |
|
44 |
[More Information Needed]
|
45 |
|
46 |
### Downstream Use [optional]
|
47 |
|
48 |
-
|
49 |
|
50 |
[More Information Needed]
|
51 |
|
52 |
### Out-of-Scope Use
|
53 |
|
54 |
-
|
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 |
-
|
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 |
|
@@ -77,14 +93,10 @@ Use the code below to get started with the model.
|
|
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]
|
@@ -92,56 +104,47 @@ Use the code below to get started with the model.
|
|
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 |
-
|
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 |
-
|
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]
|
@@ -167,11 +170,14 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
167 |
#### Software
|
168 |
|
169 |
[More Information Needed]
|
|
|
170 |
|
171 |
## Citation [optional]
|
172 |
|
173 |
-
|
174 |
|
|
|
|
|
175 |
**BibTeX:**
|
176 |
|
177 |
[More Information Needed]
|
@@ -181,9 +187,9 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
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]
|
@@ -194,6 +200,39 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
194 |
|
195 |
[More Information Needed]
|
196 |
|
197 |
-
## Model Card Contact
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
198 |
|
199 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
+
tags:
|
4 |
+
- medical
|
5 |
+
license: cc-by-nc-2.0
|
6 |
+
pipeline_tag: text-generation
|
7 |
+
language:
|
8 |
+
- en
|
9 |
---
|
10 |
|
11 |
+
# Dr. Niko (70B)
|
12 |
|
13 |
+
> This repository contains the full merged model.
|
14 |
|
15 |
+
![image/png](https://cdn-uploads.huggingface.co/production/uploads/639a31227ecb808549a0d18d/zo8Qi2hVnnurxyGfbU2rA.png)
|
16 |
+
|
17 |
+
The Dr-Niko model is designed to assist medical professionals, researchers, and students with a wide range of tasks, including answering medical and scientific questions, summarizing research papers and clinical notes, generating medical reports and documentation, providing medical advice and recommendations (with appropriate disclaimers), and assisting with medical decision-making and diagnosis (in a supporting role).
|
18 |
|
19 |
|
20 |
## Model Details
|
21 |
|
22 |
+
- **Model Name**: Dr-Niko
|
23 |
+
- **Model Type**: Medical Large Language Model (LLM)
|
24 |
+
- **Model Size**: 70 billion parameters (base model is miqu-70B)
|
25 |
+
- **Training Data**: The model was fine-tuned on a curated dataset of high-quality medical and scientific literature.
|
26 |
+
- **Fine-Tuning Approach**: The model was then fine-tuned on a medical and scientific dataset using [LLaMa-Factory ](https://github.com/hiyouga/LLaMA-Factory) for 1.5 epochs.
|
27 |
+
- **Intended Use**: The Dr-Niko model is designed to assist medical professionals, researchers, and students with a wide range of tasks, including:
|
28 |
+
- Answering medical and scientific questions
|
29 |
+
- Summarizing research papers and clinical notes (in a supporting role)
|
30 |
+
- Generating medical reports and documentation (in a supporting role)
|
31 |
+
- Providing medical advice and recommendations (with appropriate disclaimers)
|
32 |
+
- Assisting with medical decision-making and diagnosis (in a supporting role)
|
33 |
|
34 |
+
### Model Description
|
35 |
|
36 |
+
This model is next in a series of medical finetuning attempts, following medfalcon and medguanaco.
|
37 |
|
38 |
+
- **Developed by:** [Nick Mitchko](https://www.linkedin.com/in/nmitchko/)
|
39 |
+
- **Funded by :** [My Bank Account]
|
40 |
+
- **Shared by :** [My Internet]
|
41 |
+
- **Model type:** [LLaMa-70B variant]
|
42 |
+
- **Language(s) (NLP):** [English]
|
43 |
+
- **License:** [See [here](#license---nomerge)]
|
44 |
+
- **Finetuned from model [optional]:** [Miqu-70B](https://huggingface.co/152334H/miqu-1-70b-sf)
|
45 |
|
46 |
### Model Sources [optional]
|
47 |
|
48 |
<!-- Provide the basic links for the model. -->
|
49 |
|
50 |
+
- **Repository:** [Coming Soon]
|
51 |
+
- **Paper []:** [Maybe]
|
52 |
+
- **Demo []:** Maybe
|
53 |
+
<!--
|
54 |
## Uses
|
55 |
|
|
|
56 |
|
57 |
### Direct Use
|
58 |
|
59 |
+
|
60 |
|
61 |
[More Information Needed]
|
62 |
|
63 |
### Downstream Use [optional]
|
64 |
|
65 |
+
|
66 |
|
67 |
[More Information Needed]
|
68 |
|
69 |
### Out-of-Scope Use
|
70 |
|
71 |
+
|
72 |
|
73 |
[More Information Needed]
|
74 |
|
75 |
## Bias, Risks, and Limitations
|
76 |
|
|
|
77 |
|
78 |
[More Information Needed]
|
79 |
|
80 |
### Recommendations
|
81 |
|
82 |
+
|
83 |
|
84 |
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
85 |
|
|
|
93 |
|
94 |
### Training Data
|
95 |
|
|
|
|
|
96 |
[More Information Needed]
|
97 |
|
98 |
### Training Procedure
|
99 |
|
|
|
|
|
100 |
#### Preprocessing [optional]
|
101 |
|
102 |
[More Information Needed]
|
|
|
104 |
|
105 |
#### Training Hyperparameters
|
106 |
|
|
|
|
|
107 |
#### Speeds, Sizes, Times [optional]
|
108 |
|
|
|
|
|
109 |
[More Information Needed]
|
110 |
|
111 |
## Evaluation
|
112 |
|
113 |
+
|
114 |
|
115 |
### Testing Data, Factors & Metrics
|
116 |
|
117 |
#### Testing Data
|
118 |
|
|
|
|
|
119 |
[More Information Needed]
|
120 |
|
121 |
#### Factors
|
122 |
|
|
|
|
|
123 |
[More Information Needed]
|
124 |
+
-->
|
125 |
#### Metrics
|
126 |
|
127 |
+
[Formal Evaluation Coming Soon]
|
|
|
|
|
128 |
|
129 |
+
<!--
|
130 |
### Results
|
131 |
|
132 |
[More Information Needed]
|
133 |
|
134 |
#### Summary
|
135 |
|
136 |
+
-->
|
137 |
+
<!--
|
138 |
## Model Examination [optional]
|
139 |
+
-->
|
140 |
<!-- Relevant interpretability work for the model goes here -->
|
141 |
+
<!--
|
142 |
[More Information Needed]
|
143 |
|
144 |
## Environmental Impact
|
145 |
+
-->
|
146 |
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
147 |
+
<!--
|
148 |
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).
|
149 |
|
150 |
- **Hardware Type:** [More Information Needed]
|
|
|
170 |
#### Software
|
171 |
|
172 |
[More Information Needed]
|
173 |
+
-->
|
174 |
|
175 |
## Citation [optional]
|
176 |
|
177 |
+
Information Coming Soon
|
178 |
|
179 |
+
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
180 |
+
<!--
|
181 |
**BibTeX:**
|
182 |
|
183 |
[More Information Needed]
|
|
|
187 |
[More Information Needed]
|
188 |
|
189 |
## Glossary [optional]
|
190 |
+
-->
|
191 |
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
192 |
+
<!--
|
193 |
[More Information Needed]
|
194 |
|
195 |
## More Information [optional]
|
|
|
200 |
|
201 |
[More Information Needed]
|
202 |
|
203 |
+
## Model Card Contact
|
204 |
+
|
205 |
+
[More Information Needed]
|
206 |
+
|
207 |
+
-->
|
208 |
+
|
209 |
+
## License - NOMERGE
|
210 |
+
|
211 |
+
```
|
212 |
+
NOMERGE License
|
213 |
+
|
214 |
+
Copyright (c) 2024 152334H
|
215 |
+
|
216 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
217 |
+
of this software and associated documentation files (the "Software"), to deal
|
218 |
+
in the Software without restriction, including without limitation the rights
|
219 |
+
to use, copy, modify, NOT merge, publish, distribute, sublicense, and/or sell
|
220 |
+
copies of the Software, and to permit persons to whom the Software is
|
221 |
+
furnished to do so, subject to the following conditions:
|
222 |
+
|
223 |
+
The above copyright notice and this permission notice shall be included in all
|
224 |
+
copies or substantial portions of the Software.
|
225 |
+
|
226 |
+
All tensors ("weights") provided by the Software shall not be conjoined with
|
227 |
+
other tensors ("merging") unless given explicit permission by the license holder.
|
228 |
+
Utilities including but not limited to "mergekit", "MergeMonster", are forbidden
|
229 |
+
from use in conjunction with this Software.
|
230 |
|
231 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
232 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
233 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
234 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
235 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
236 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
237 |
+
SOFTWARE.
|
238 |
+
```
|