dextersud commited on
Commit
235718d
·
verified ·
1 Parent(s): ab2571b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +98 -198
README.md CHANGED
@@ -1,199 +1,99 @@
1
- ---
2
  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]
 
 
1
  library_name: transformers
2
+ license: mit
3
+ language:
4
+
5
+ en
6
+ base_model: meta-llama/Llama-2-7b-hf
7
+ Model Card for Clinical Studies Instruction-Finetuned LLaMA-7B
8
+ Model Details
9
+ Model Description
10
+ This model is a fine-tuned version of the LLaMA-2-7B model from Meta, optimized using 1.5 lakh open-source clinical studies data for instruction-based tasks. The fine-tuning process has tailored the model to better understand and generate responses in the domain of clinical studies, making it particularly useful for tasks involving medical and clinical research data.
11
+
12
+ Developed by: Shudhanshu Shekhar
13
+ Model type: Instruction-finetuned LLaMA-2-7B
14
+ Language(s) (NLP): English
15
+ License: MIT
16
+ Finetuned from model: Meta's LLaMA-2-7B
17
+ Model Sources
18
+ Repository: [Link to your Hugging Face model repository]
19
+ Paper [optional]: [Link to any related paper]
20
+ Demo [optional]: [Link to a demo if available]
21
+ Uses
22
+ Direct Use
23
+ This model can be directly used for generating responses or insights from clinical studies data, facilitating tasks such as summarization, information retrieval, and instruction following in the medical and clinical research fields.
24
+
25
+ Downstream Use
26
+ The model can be further fine-tuned or integrated into applications focused on clinical decision support, medical research analysis, or healthcare-related natural language processing tasks.
27
+
28
+ Out-of-Scope Use
29
+ This model is not suitable for real-time medical diagnosis, treatment recommendations, or any other critical medical decision-making processes without human oversight. Misuse in contexts requiring precise and validated medical information could lead to incorrect or harmful outcomes.
30
+
31
+ Bias, Risks, and Limitations
32
+ While the model has been fine-tuned on clinical studies data, it may still exhibit biases present in the original data. Users should be cautious when interpreting outputs, particularly in sensitive or critical contexts such as healthcare. The model may also produce outdated or incorrect information if the underlying data is not current.
33
+
34
+ Recommendations
35
+ Users should critically evaluate the model's outputs and consider the context in which it is being used. It is advisable to have human oversight when deploying the model in healthcare or clinical environments.
36
+
37
+ How to Get Started with the Model
38
+ Use the code below to get started with the model:
39
+
40
+ python
41
+ Copy code
42
+ from transformers import AutoModelForCausalLM, AutoTokenizer
43
+
44
+ tokenizer = AutoTokenizer.from_pretrained("your-hf-username/clinical-llama-7b")
45
+ model = AutoModelForCausalLM.from_pretrained("your-hf-username/clinical-llama-7b")
46
+
47
+ input_text = "Summarize the following clinical study on..."
48
+ inputs = tokenizer(input_text, return_tensors="pt")
49
+ outputs = model.generate(**inputs)
50
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
51
+ Training Details
52
+ Training Data
53
+ The model was fine-tuned on a dataset of 1.5 lakh open-source clinical studies, focusing on enhancing its ability to follow instructions and generate informative content within the medical and clinical research domains.
54
+
55
+ Training Procedure
56
+ Training regime: Mixed precision training with fp16
57
+ Hardware: NVIDIA A100 GPUs
58
+ Training duration: Approximately [insert hours/days]
59
+ Evaluation
60
+ Testing Data, Factors & Metrics
61
+ Testing Data
62
+ The model was evaluated on a subset of clinical studies data that was not seen during training.
63
+
64
+ Metrics
65
+ The evaluation focused on accuracy in following instructions, the relevance of generated responses, and the preservation of key medical facts.
66
+
67
+ Results
68
+ The fine-tuned model demonstrated improved performance in generating accurate and contextually relevant responses in the domain of clinical studies, outperforming the base model in instruction-following tasks.
69
+
70
+ Environmental Impact
71
+ Hardware Type: NVIDIA A100 GPUs
72
+ Hours used: [insert hours]
73
+ Cloud Provider: [insert cloud provider if applicable]
74
+ Compute Region: [insert compute region]
75
+ Carbon Emitted: [insert carbon emissions if known]
76
+ Technical Specifications
77
+ Model Architecture and Objective
78
+ The model architecture is based on Meta's LLaMA-2-7B, optimized for natural language processing tasks, with a focus on clinical studies data.
79
+
80
+ Compute Infrastructure
81
+ Hardware
82
+ Training was conducted on NVIDIA A100 GPUs.
83
+
84
+ Software
85
+ The fine-tuning was performed using the PyTorch framework with the Hugging Face Transformers library.
86
+
87
+ Citation
88
+ If you use this model in your research, please cite:
89
+
90
+ bibtex
91
+ Copy code
92
+ @article{shekhar2024clinicalllama,
93
+ title={Clinical Studies Instruction-Finetuned LLaMA-7B},
94
+ author={Shudhanshu Shekhar},
95
+ year={2024},
96
+ howpublished={\url{https://huggingface.co/your-hf-username/clinical-llama-7b}},
97
+ }
98
+ Model Card Authors
99
+ Shudhanshu Shekhar