Update README.md
Browse files
README.md
CHANGED
|
@@ -4,11 +4,11 @@ tags:
|
|
| 4 |
- unsloth
|
| 5 |
---
|
| 6 |
|
| 7 |
-
# Model Card for
|
| 8 |
|
| 9 |
<!-- Provide a quick summary of what the model is/does. -->
|
| 10 |
|
| 11 |
-
|
| 12 |
|
| 13 |
## Model Details
|
| 14 |
|
|
@@ -16,185 +16,60 @@ tags:
|
|
| 16 |
|
| 17 |
<!-- Provide a longer summary of what this model is. -->
|
| 18 |
|
| 19 |
-
This is the model card of a 🤗
|
| 20 |
|
| 21 |
-
- **Developed by:**
|
| 22 |
-
- **Funded by [optional]:**
|
| 23 |
-
- **Shared by [optional]:**
|
| 24 |
-
- **Model type:**
|
| 25 |
-
- **Language(s) (NLP):**
|
| 26 |
-
- **License:**
|
| 27 |
-
- **Finetuned from model [optional]:**
|
| 28 |
|
| 29 |
### Model Sources [optional]
|
| 30 |
|
| 31 |
<!-- Provide the basic links for the model. -->
|
| 32 |
|
| 33 |
-
- **Repository:** [
|
| 34 |
-
- **Paper [optional]:**
|
| 35 |
-
- **Demo [optional]:**
|
| 36 |
|
| 37 |
## Uses
|
| 38 |
|
| 39 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 40 |
-
|
| 41 |
### Direct Use
|
| 42 |
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
[More Information Needed]
|
| 46 |
|
| 47 |
### Downstream Use [optional]
|
| 48 |
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
|
| 53 |
### Out-of-Scope Use
|
| 54 |
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
|
| 59 |
## Bias, Risks, and Limitations
|
| 60 |
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
|
| 65 |
### Recommendations
|
| 66 |
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 70 |
|
| 71 |
## How to Get Started with the Model
|
| 72 |
|
| 73 |
Use the code below to get started with the model.
|
| 74 |
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
## Training Details
|
| 78 |
-
|
| 79 |
-
### Training Data
|
| 80 |
-
|
| 81 |
-
<!-- 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. -->
|
| 82 |
-
|
| 83 |
-
[More Information Needed]
|
| 84 |
-
|
| 85 |
-
### Training Procedure
|
| 86 |
-
|
| 87 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 88 |
-
|
| 89 |
-
#### Preprocessing [optional]
|
| 90 |
-
|
| 91 |
-
[More Information Needed]
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
#### Training Hyperparameters
|
| 95 |
-
|
| 96 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 97 |
-
|
| 98 |
-
#### Speeds, Sizes, Times [optional]
|
| 99 |
-
|
| 100 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 101 |
-
|
| 102 |
-
[More Information Needed]
|
| 103 |
-
|
| 104 |
-
## Evaluation
|
| 105 |
-
|
| 106 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 107 |
-
|
| 108 |
-
### Testing Data, Factors & Metrics
|
| 109 |
-
|
| 110 |
-
#### Testing Data
|
| 111 |
-
|
| 112 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 113 |
-
|
| 114 |
-
[More Information Needed]
|
| 115 |
-
|
| 116 |
-
#### Factors
|
| 117 |
-
|
| 118 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 119 |
-
|
| 120 |
-
[More Information Needed]
|
| 121 |
-
|
| 122 |
-
#### Metrics
|
| 123 |
-
|
| 124 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 125 |
-
|
| 126 |
-
[More Information Needed]
|
| 127 |
-
|
| 128 |
-
### Results
|
| 129 |
-
|
| 130 |
-
[More Information Needed]
|
| 131 |
-
|
| 132 |
-
#### Summary
|
| 133 |
-
|
| 134 |
-
|
| 135 |
-
|
| 136 |
-
## Model Examination [optional]
|
| 137 |
-
|
| 138 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 139 |
-
|
| 140 |
-
[More Information Needed]
|
| 141 |
-
|
| 142 |
-
## Environmental Impact
|
| 143 |
-
|
| 144 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 145 |
-
|
| 146 |
-
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).
|
| 147 |
-
|
| 148 |
-
- **Hardware Type:** [More Information Needed]
|
| 149 |
-
- **Hours used:** [More Information Needed]
|
| 150 |
-
- **Cloud Provider:** [More Information Needed]
|
| 151 |
-
- **Compute Region:** [More Information Needed]
|
| 152 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 153 |
-
|
| 154 |
-
## Technical Specifications [optional]
|
| 155 |
-
|
| 156 |
-
### Model Architecture and Objective
|
| 157 |
-
|
| 158 |
-
[More Information Needed]
|
| 159 |
-
|
| 160 |
-
### Compute Infrastructure
|
| 161 |
-
|
| 162 |
-
[More Information Needed]
|
| 163 |
-
|
| 164 |
-
#### Hardware
|
| 165 |
-
|
| 166 |
-
[More Information Needed]
|
| 167 |
-
|
| 168 |
-
#### Software
|
| 169 |
-
|
| 170 |
-
[More Information Needed]
|
| 171 |
-
|
| 172 |
-
## Citation [optional]
|
| 173 |
-
|
| 174 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 175 |
-
|
| 176 |
-
**BibTeX:**
|
| 177 |
-
|
| 178 |
-
[More Information Needed]
|
| 179 |
-
|
| 180 |
-
**APA:**
|
| 181 |
-
|
| 182 |
-
[More Information Needed]
|
| 183 |
-
|
| 184 |
-
## Glossary [optional]
|
| 185 |
-
|
| 186 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 187 |
-
|
| 188 |
-
[More Information Needed]
|
| 189 |
-
|
| 190 |
-
## More Information [optional]
|
| 191 |
-
|
| 192 |
-
[More Information Needed]
|
| 193 |
-
|
| 194 |
-
## Model Card Authors [optional]
|
| 195 |
-
|
| 196 |
-
[More Information Needed]
|
| 197 |
-
|
| 198 |
-
## Model Card Contact
|
| 199 |
|
| 200 |
-
|
|
|
|
|
|
|
|
|
| 4 |
- unsloth
|
| 5 |
---
|
| 6 |
|
| 7 |
+
# Model Card for LLAMA-DISEASE-CURE
|
| 8 |
|
| 9 |
<!-- Provide a quick summary of what the model is/does. -->
|
| 10 |
|
| 11 |
+
`LLAMA-DISEASE-CURE` is a fine-tuned version of the LLaMA-3 8B model optimized for disease classification and suggesting potential cures based on patient textual input. This model helps automate the mapping of symptoms to diseases and treatment strategies, enabling applications in AI-powered clinical decision support tools.
|
| 12 |
|
| 13 |
## Model Details
|
| 14 |
|
|
|
|
| 16 |
|
| 17 |
<!-- Provide a longer summary of what this model is. -->
|
| 18 |
|
| 19 |
+
This is the model card of a 🤗 Transformers model pushed to the Hub by Kshitij Sharma. It has been fine-tuned using Unsloth’s efficient low-bit training (4-bit quantization) on a medical dataset containing patient symptoms and corresponding diseases with treatments.
|
| 20 |
|
| 21 |
+
- **Developed by:** Kshitij Sharma
|
| 22 |
+
- **Funded by [optional]:** Self-funded
|
| 23 |
+
- **Shared by [optional]:** Kshitij Sharma
|
| 24 |
+
- **Model type:** Text Classification (Medical NLP)
|
| 25 |
+
- **Language(s) (NLP):** English
|
| 26 |
+
- **License:** Apache 2.0
|
| 27 |
+
- **Finetuned from model [optional]:** unsloth/llama-3-8b-bnb-4bit
|
| 28 |
|
| 29 |
### Model Sources [optional]
|
| 30 |
|
| 31 |
<!-- Provide the basic links for the model. -->
|
| 32 |
|
| 33 |
+
- **Repository:** [https://huggingface.co/kshitij230/LLAMA-DISEASE-CURE](https://huggingface.co/kshitij230/LLAMA-DISEASE-CURE)
|
| 34 |
+
- **Paper [optional]:** N/A
|
| 35 |
+
- **Demo [optional]:** Coming soon
|
| 36 |
|
| 37 |
## Uses
|
| 38 |
|
|
|
|
|
|
|
| 39 |
### Direct Use
|
| 40 |
|
| 41 |
+
- Text classification of patient-reported symptoms into disease categories
|
| 42 |
+
- Generation of suggested cures or treatments based on classified disease
|
|
|
|
| 43 |
|
| 44 |
### Downstream Use [optional]
|
| 45 |
|
| 46 |
+
- Integration into clinical assistants or triage bots
|
| 47 |
+
- Medical report preprocessing or symptom understanding tools
|
| 48 |
+
- Telemedicine AI assistant solutions
|
| 49 |
|
| 50 |
### Out-of-Scope Use
|
| 51 |
|
| 52 |
+
- Should not be used for critical, real-time medical diagnosis
|
| 53 |
+
- Not a substitute for licensed medical professionals
|
| 54 |
+
- Should not be used in emergencies or for prescribing medication
|
| 55 |
|
| 56 |
## Bias, Risks, and Limitations
|
| 57 |
|
| 58 |
+
- Limited by the coverage and quality of the dataset used
|
| 59 |
+
- May not generalize well to rare diseases or symptoms expressed in colloquial terms
|
| 60 |
+
- May contain biases present in training data (e.g., demographic or linguistic)
|
| 61 |
|
| 62 |
### Recommendations
|
| 63 |
|
| 64 |
+
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. It is recommended that all outputs are reviewed by qualified healthcare professionals before clinical use.
|
|
|
|
|
|
|
| 65 |
|
| 66 |
## How to Get Started with the Model
|
| 67 |
|
| 68 |
Use the code below to get started with the model.
|
| 69 |
|
| 70 |
+
```python
|
| 71 |
+
from transformers import pipeline
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 72 |
|
| 73 |
+
classifier = pipeline("text-classification", model="kshitij230/LLAMA-DISEASE-CURE")
|
| 74 |
+
output = classifier("Patient reports shortness of breath, chest pain, and dizziness.")
|
| 75 |
+
print(output)
|