Mayank-22 commited on
Commit
4933d83
·
verified ·
1 Parent(s): 0d33c04

Update README

Browse files
Files changed (1) hide show
  1. README.md +230 -188
README.md CHANGED
@@ -1,197 +1,239 @@
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:** Mayank Malviya
21
- - **Model type:** AI Model based on Supervised Learning
22
- - **Language(s) (NLP):**
23
- - **License:** [More Information Needed]
24
- - **Finetuned from model [optional]:** [More Information Needed]
25
-
26
- ### Model Sources [optional]
27
-
28
- <!-- Provide the basic links for the model. -->
29
-
30
- - **Repository:** [More Information Needed]
31
- - **Paper [optional]:** [More Information Needed]
32
- - **Demo [optional]:** [More Information Needed]
33
-
34
- ## Uses
35
-
36
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
37
-
38
- ### Direct Use
39
-
40
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
41
-
42
- [More Information Needed]
43
-
44
- ### Downstream Use [optional]
45
-
46
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
47
-
48
- [More Information Needed]
49
-
50
- ### Out-of-Scope Use
51
-
52
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
53
-
54
- [More Information Needed]
55
-
56
- ## Bias, Risks, and Limitations
57
-
58
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
59
-
60
- [More Information Needed]
61
-
62
- ### Recommendations
63
-
64
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
65
-
66
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
67
-
68
- ## How to Get Started with the Model
69
-
70
- Use the code below to get started with the model.
71
-
72
- [More Information Needed]
73
-
74
- ## Training Details
75
-
76
- ### Training Data
77
-
78
- <!-- 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. -->
79
-
80
- [More Information Needed]
81
-
82
- ### Training Procedure
83
-
84
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
85
-
86
- #### Preprocessing [optional]
87
-
88
- [More Information Needed]
89
-
90
-
91
- #### Training Hyperparameters
92
-
93
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
94
-
95
- #### Speeds, Sizes, Times [optional]
96
-
97
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
98
-
99
- [More Information Needed]
100
-
101
- ## Evaluation
102
-
103
- <!-- This section describes the evaluation protocols and provides the results. -->
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
104
 
105
- ### Testing Data, Factors & Metrics
106
-
107
- #### Testing Data
108
-
109
- <!-- This should link to a Dataset Card if possible. -->
110
-
111
- [More Information Needed]
112
-
113
- #### Factors
114
-
115
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
116
-
117
- [More Information Needed]
118
-
119
- #### Metrics
120
-
121
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
122
-
123
- [More Information Needed]
124
-
125
- ### Results
126
-
127
- [More Information Needed]
128
-
129
- #### Summary
130
-
131
-
132
-
133
- ## Model Examination [optional]
134
-
135
- <!-- Relevant interpretability work for the model goes here -->
136
-
137
- [More Information Needed]
138
-
139
- ## Environmental Impact
140
-
141
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
142
-
143
- 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).
144
-
145
- - **Hardware Type:** [More Information Needed]
146
- - **Hours used:** [More Information Needed]
147
- - **Cloud Provider:** [More Information Needed]
148
- - **Compute Region:** [More Information Needed]
149
- - **Carbon Emitted:** [More Information Needed]
150
-
151
- ## Technical Specifications [optional]
152
-
153
- ### Model Architecture and Objective
154
-
155
- [More Information Needed]
156
-
157
- ### Compute Infrastructure
158
-
159
- [More Information Needed]
160
-
161
- #### Hardware
162
-
163
- [More Information Needed]
164
-
165
- #### Software
166
-
167
- [More Information Needed]
168
-
169
- ## Citation [optional]
170
-
171
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
172
-
173
- **BibTeX:**
174
-
175
- [More Information Needed]
176
-
177
- **APA:**
178
-
179
- [More Information Needed]
180
-
181
- ## Glossary [optional]
182
-
183
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
184
-
185
- [More Information Needed]
186
-
187
- ## More Information [optional]
188
-
189
- [More Information Needed]
190
-
191
- ## Model Card Authors [optional]
192
-
193
- [More Information Needed]
194
-
195
- ## Model Card Contact
196
 
197
- [More Information Needed]
 
1
+ # Mayank-AI: Medical AI Assistant Model
 
 
 
 
 
2
 
3
+ [![Hugging Face](https://img.shields.io/badge/🤗%20Hugging%20Face-Model-blue)](https://huggingface.co/Mayank-22/Mayank-AI)
4
+ [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
5
+ [![Medical AI](https://img.shields.io/badge/Domain-Medical%20AI-red)](https://huggingface.co/Mayank-22/Mayank-AI)
6
 
7
+ ## 📋 Model Overview
8
 
9
+ Mayank-AI is a specialized artificial intelligence model designed for Indian pharmaceutical and medical applications, trained on comprehensive Indian medicines datasets. This model leverages supervised learning techniques built on GPT-2 transformer architecture to provide accurate and contextually relevant information about Indian medicines, their compounds, uses, and related medical information.
10
 
11
+ ## 🔍 Model Details
12
 
13
  ### Model Description
 
 
 
 
 
14
  - **Developed by:** Mayank Malviya
15
+ - **Model Type:** GPT-2 based Transformer for Indian Medical/Pharmaceutical Applications
16
+ - **Language(s):** English (with Indian medical terminology and drug names)
17
+ - **License:** Apache 2.0
18
+ - **Domain:** Indian Pharmaceuticals & Medicine Information
19
+ - **Primary Use:** Indian medicine information, drug compound analysis, symptom mapping, prescription guidance
20
+
21
+ ### Key Features
22
+ - Indian medicines database knowledge
23
+ - ✅ Drug compound information and analysis
24
+ - Symptom-to-medicine mapping
25
+ - Prescription guidance and recommendations
26
+ - Disease diagnosis assistance
27
+ - ✅ Indian pharmaceutical market insights
28
+ - ✅ Medicine availability and alternatives
29
+
30
+ ## 🚀 Quick Start
31
+
32
+ ### Installation
33
+ ```bash
34
+ pip install transformers torch
35
+ ```
36
+
37
+ ### Basic Usage
38
+ ```python
39
+ from transformers import AutoTokenizer, AutoModelForCausalLM
40
+ import torch
41
+
42
+ # Load model and tokenizer
43
+ model_name = "Mayank-22/Mayank-AI"
44
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
45
+ model = AutoModelForCausalLM.from_pretrained(model_name)
46
+
47
+ # Example queries for Indian medicines
48
+ query1 = "What is the composition of Crocin tablet?"
49
+ query2 = "Which medicine is used for fever and headache?"
50
+ query3 = "What are the side effects of Paracetamol?"
51
+ query4 = "Medicines available for diabetes in India"
52
+
53
+ # Process query
54
+ inputs = tokenizer.encode(query1, return_tensors="pt")
55
+
56
+ # Generate response
57
+ with torch.no_grad():
58
+ outputs = model.generate(
59
+ inputs,
60
+ max_length=512,
61
+ num_return_sequences=1,
62
+ temperature=0.7,
63
+ do_sample=True,
64
+ pad_token_id=tokenizer.eos_token_id
65
+ )
66
+
67
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
68
+ print(response)
69
+ ```
70
+
71
+ ### Advanced Usage
72
+ ```python
73
+ # For more controlled generation about Indian medicines
74
+ def generate_medicine_response(question, max_length=256):
75
+ prompt = f"Indian Medicine Query: {question}\nResponse:"
76
+ inputs = tokenizer.encode(prompt, return_tensors="pt")
77
+
78
+ outputs = model.generate(
79
+ inputs,
80
+ max_length=max_length,
81
+ num_return_sequences=1,
82
+ temperature=0.6,
83
+ do_sample=True,
84
+ top_p=0.9,
85
+ repetition_penalty=1.1
86
+ )
87
+
88
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
89
+ return response.split("Response:")[-1].strip()
90
+
91
+ # Example usage
92
+ question = "What are the uses of Azithromycin tablets available in India?"
93
+ answer = generate_medicine_response(question)
94
+ print(answer)
95
+ ```
96
+
97
+ ## 📊 Performance & Capabilities
98
+
99
+ ### Supported Medical Areas
100
+ - **Indian Pharmaceuticals:** Comprehensive database of medicines available in India
101
+ - **Drug Compounds:** Active ingredients, chemical compositions, formulations
102
+ - **Symptom Analysis:** Symptom-to-medicine mapping and recommendations
103
+ - **Disease Information:** Common diseases and their standard treatments in India
104
+ - **Prescription Guidance:** Dosage, administration, and usage instructions
105
+ - **Drug Interactions:** Side effects and contraindications
106
+ - **Medicine Alternatives:** Generic and branded medicine alternatives
107
+
108
+ ### Performance Metrics
109
+ - **Training Data:** Indian medicines dataset with comprehensive drug information
110
+ - **Specialization:** Focused on Indian pharmaceutical market and medicine availability
111
+ - **Coverage:** Extensive database of Indian medicines, their compounds, and uses
112
+ - **Accuracy:** High precision in Indian medicine information and drug compound details
113
+
114
+ ## ⚠️ Important Medical Disclaimer
115
+
116
+ > **CRITICAL NOTICE:** This model is for informational and educational purposes only. It should NOT be used as a substitute for professional medical advice, diagnosis, or treatment. Always consult with qualified healthcare providers for medical concerns.
117
+
118
+ ### Limitations & Risks
119
+ - **Not a replacement for medical professionals**
120
+ - **May contain inaccuracies or outdated information**
121
+ - **Should not be used for emergency medical situations**
122
+ - **Requires human oversight for clinical applications**
123
+ - **May have biases present in training data**
124
+
125
+ ## 🎯 Intended Use Cases
126
+
127
+ ### ✅ Appropriate Uses
128
+ - Indian pharmaceutical research and education
129
+ - Medicine information lookup and comparison
130
+ - Drug compound analysis and research
131
+ - Symptom-to-medicine mapping assistance
132
+ - Prescription guidance and dosage information
133
+ - Medicine availability and alternatives research
134
+ - Healthcare app development and integration
135
+
136
+ ### ❌ Inappropriate Uses
137
+ - Direct patient diagnosis
138
+ - Emergency medical decisions
139
+ - Prescription or treatment recommendations without medical supervision
140
+ - Replacement for clinical judgment
141
+ - Use without proper medical context
142
+
143
+ ## 🔧 Technical Specifications
144
+
145
+ ### Model Architecture
146
+ - **Base Architecture:** GPT-2 Transformer model
147
+ - **Fine-tuning:** Supervised learning on Indian medicines dataset
148
+ - **Context Length:** Standard GPT-2 context window
149
+ - **Training Approach:** Domain-specific fine-tuning on pharmaceutical data
150
+
151
+ ### Training Details
152
+ - **Training Data:** Indian medicines dataset including:
153
+ - Medicine names and brand information
154
+ - Drug compounds and chemical compositions
155
+ - Symptom-medicine mappings
156
+ - Prescription guidelines and dosages
157
+ - Disease-treatment associations
158
+ - Side effects and contraindications
159
+ - **Training Regime:** Supervised fine-tuning on GPT-2 with pharmaceutical domain adaptation
160
+ - **Optimization:** Adam optimizer with learning rate scheduling
161
+ - **Data Focus:** Indian pharmaceutical market and medicine availability
162
+
163
+ ## 📚 Datasets & Training
164
+
165
+ ### Training Data Sources
166
+ - Comprehensive Indian medicines database
167
+ - Drug compound and chemical composition data
168
+ - Symptom-medicine relationship mappings
169
+ - Prescription guidelines and dosage information
170
+ - Disease-treatment associations
171
+ - Medicine availability and market data
172
+
173
+ ### Data Preprocessing
174
+ - Medicine name normalization and standardization
175
+ - Drug compound data structure optimization
176
+ - Symptom-medicine relationship mapping
177
+ - Quality filtering and validation of pharmaceutical data
178
+ - Indian market-specific data curation
179
+
180
+ ## 🧪 Evaluation & Validation
181
+
182
+ ### Evaluation Metrics
183
+ - **Medicine Information Accuracy:** Correctness of drug compound and usage information
184
+ - **Symptom Mapping Precision:** Accuracy of symptom-to-medicine recommendations
185
+ - **Indian Market Relevance:** Appropriateness for Indian pharmaceutical context
186
+ - **Safety Assessment:** Risk evaluation for medicine information provision
187
+
188
+ ### Benchmark Performance
189
+ - **Indian Medicine Database:** Comprehensive coverage of medicines available in India
190
+ - **Drug Compound Accuracy:** High precision in chemical composition information
191
+ - **Symptom-Medicine Mapping:** Effective symptom-to-treatment recommendations
192
+
193
+ ## 🔄 Updates & Maintenance
194
+
195
+ This model is maintained and updated with:
196
+ - Latest Indian medicine information
197
+ - New drug approvals and market entries
198
+ - Updated compound and formulation data
199
+ - Enhanced symptom-medicine mappings
200
+
201
+ ## 📖 Citation
202
+
203
+ If you use this model in your research, please cite:
204
+
205
+ ```bibtex
206
+ @misc{mayank2024indianmedicines,
207
+ title={Mayank-AI: Indian Medicines Information Model},
208
+ author={Malviya, Mayank},
209
+ year={2024},
210
+ url={https://huggingface.co/Mayank-22/Mayank-AI},
211
+ note={GPT-2 based model for Indian pharmaceutical information}
212
+ }
213
+ ```
214
+
215
+ ## 🤝 Contributing
216
+
217
+ Contributions to improve the model are welcome! Please:
218
+ - Report issues with medicine information accuracy
219
+ - Suggest new Indian medicines to include
220
+ - Share feedback on drug compound data
221
+ - Contribute to symptom-medicine mapping improvements
222
+
223
+ ## 📞 Contact & Support
224
+
225
+ - **Model Author:** Mayank Malviya
226
+ - **Repository:** [Mayank-22/Mayank-AI](https://huggingface.co/Mayank-22/Mayank-AI)
227
+ - **Issues:** Please report issues through the Hugging Face repository
228
+
229
+ ## 📄 License
230
+
231
+ This model is released under the Apache 2.0 License. See the LICENSE file for details.
232
+
233
+ ## 🙏 Acknowledgments
234
+
235
+ Special thanks to the Indian pharmaceutical community, healthcare professionals, and medical researchers who contributed to the development and validation of this specialized model for Indian medicines.
236
 
237
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
238
 
239
+ **Remember:** This AI model is a tool to assist, not replace, medical professionals. Always prioritize patient safety and seek professional medical advice for healthcare decisions.