tasal9 commited on
Commit
87c92bf
Β·
verified Β·
1 Parent(s): b43e9a1

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +22 -161
README.md CHANGED
@@ -8,16 +8,12 @@ tags:
8
  - llama3
9
  - pashto
10
  - advanced-llm
 
11
  - conversation
12
  base_model: meta-llama/Meta-Llama-3-8B-Instruct
13
  pipeline_tag: text-generation
14
  datasets:
15
  - tasal9/Pashto-Dataset-Creating-Dataset
16
- widget:
17
- - text: "Hello, how are you?"
18
- example_title: "English Greeting"
19
- - text: "Ψ³Ω„Ψ§Ω… ΩˆΨ±ΩˆΨ±Ω‡ΨŒ Ϊ…Ω†Ϊ«Ω‡ یاسΨͺ؟"
20
- example_title: "Pashto Greeting"
21
  ---
22
 
23
  # ZamAI-LIama3-Pashto
@@ -33,25 +29,14 @@ This model is part of the **ZamAI Pro Models Strategy** - a comprehensive AI pla
33
  - 🌐 **Multilingual**: Optimized for Pashto and English
34
  - ⚑ **High Performance**: Optimized for production deployment
35
  - πŸ”’ **Secure**: Enterprise-grade security and privacy
36
- - πŸ“± **Production Ready**: Deployed and tested in real applications
37
-
38
- ## 🎯 Use Cases
39
-
40
- This model excels at:
41
- - **Educational Content**: Pashto language tutoring and learning
42
- - **Business Applications**: Document processing and analysis
43
- - **Voice Interactions**: Natural language understanding
44
- - **Cultural Applications**: Supporting Pashto language technology
45
- - **Cross-lingual Tasks**: Translation and multilingual understanding
46
 
47
  ## πŸ“š Usage
48
 
49
- ### Quick Start with Transformers
50
 
51
  ```python
52
  from transformers import AutoTokenizer, AutoModel
53
 
54
- # Load the model
55
  tokenizer = AutoTokenizer.from_pretrained("tasal9/ZamAI-LIama3-Pashto")
56
  model = AutoModel.from_pretrained("tasal9/ZamAI-LIama3-Pashto")
57
 
@@ -61,173 +46,49 @@ inputs = tokenizer(text, return_tensors="pt")
61
  outputs = model(**inputs)
62
  ```
63
 
64
- ### Using Hugging Face Inference API
65
 
66
  ```python
67
  from huggingface_hub import InferenceClient
68
 
69
  client = InferenceClient(token="your_hf_token")
70
 
71
- # For text generation
72
  response = client.text_generation(
73
  model="tasal9/ZamAI-LIama3-Pashto",
74
  prompt="Your prompt here",
75
- max_new_tokens=200,
76
- temperature=0.7
77
- )
78
-
79
- print(response)
80
- ```
81
-
82
- ### Integration with ZamAI Platform
83
-
84
- ```python
85
- from zamai_platform import ZamAIClient
86
-
87
- # Initialize with your model
88
- zamai = ZamAIClient(model="ZamAI-LIama3-Pashto")
89
-
90
- # Use the model
91
- result = zamai.generate(
92
- prompt="Your input",
93
- language="pashto", # or "english"
94
- task_type="text-generation"
95
  )
96
  ```
97
 
98
- ## πŸ”§ Technical Specifications
99
-
100
- | Attribute | Value |
101
- |-----------|-------|
102
- | **Model Type** | text-generation |
103
- | **Base Model** | meta-llama/Meta-Llama-3-8B-Instruct |
104
- | **Languages** | Pashto (ps), English (en) |
105
- | **License** | MIT |
106
- | **Parameters** | Optimized for efficiency |
107
- | **Context Length** | Variable (model-dependent) |
108
-
109
- ## πŸ“Š Performance Metrics
110
-
111
- | Metric | Score | Notes |
112
- |--------|-------|-------|
113
- | **Accuracy** | 92.5% | On Pashto evaluation set |
114
- | **BLEU Score** | 0.85 | Translation quality |
115
- | **Cultural Relevance** | 95% | Pashto cultural context |
116
- | **Response Time** | <200ms | Average inference time |
117
- | **Multilingual Score** | 89% | Cross-lingual performance |
118
-
119
- ## πŸš€ Deployment Options
120
-
121
- ### 1. Hugging Face Inference API
122
- ```python
123
- from huggingface_hub import InferenceClient
124
- client = InferenceClient(model="tasal9/ZamAI-LIama3-Pashto")
125
- ```
126
-
127
- ### 2. Local Deployment
128
- ```bash
129
- # Clone and run locally
130
- git clone https://huggingface.co/tasal9/ZamAI-LIama3-Pashto
131
- python run_model.py --model-path ./ZamAI-LIama3-Pashto
132
- ```
133
-
134
- ### 3. Docker Deployment
135
- ```bash
136
- # Use official ZamAI Docker images
137
- docker run -p 8000:8000 zamai/zamai-liama3-pashto:latest
138
- ```
139
-
140
- ### 4. Cloud Deployment
141
- ```python
142
- # Deploy on your preferred cloud platform
143
- # Supports AWS, GCP, Azure, and more
144
- ```
145
-
146
- ## 🌍 Real-World Applications
147
-
148
- This model is actively used in:
149
-
150
- - **πŸŽ“ ZamAI Educational Platform**: Powering Pashto language tutoring
151
- - **πŸ“„ Business Automation**: Document processing and analysis
152
- - **🎀 Voice Assistants**: Natural language understanding
153
- - **πŸ›οΈ Cultural Preservation**: Supporting Pashto language technology
154
- - **🌐 Translation Services**: Cross-lingual communication tools
155
-
156
- ## πŸ“ˆ Model Updates & Versions
157
 
158
- | Version | Date | Changes |
159
- |---------|------|---------|
160
- | **v1.0** | 2025-07-05 | Initial release with enhanced Pashto support |
161
- | **v1.1** | TBD | Performance optimizations |
162
- | **v2.0** | TBD | Extended language support |
163
 
164
- ## 🀝 Contributing & Community
165
 
166
- We welcome contributions to improve this model:
 
 
 
 
167
 
168
- ### πŸ“ Data Contributions
169
- - Share Pashto language datasets
170
- - Provide cultural context and corrections
171
- - Submit evaluation benchmarks
172
-
173
- ### πŸ”§ Model Improvements
174
- - Suggest architectural enhancements
175
- - Report performance issues
176
- - Contribute fine-tuning datasets
177
-
178
- ### πŸ’‘ Applications
179
- - Build new use cases and integrations
180
- - Share success stories
181
- - Contribute to the ecosystem
182
-
183
- ## πŸ“ž Support & Contact
184
-
185
- For enterprise support, custom fine-tuning, or integration assistance:
186
 
 
187
  - πŸ“§ **Email**: [email protected]
188
  - 🌐 **Website**: [zamai.ai](https://zamai.ai)
189
- - πŸ“– **Documentation**: [docs.zamai.ai](https://docs.zamai.ai)
190
- - πŸ’¬ **Community**: [ZamAI Community Forum](https://community.zamai.ai)
191
- - πŸ™ **GitHub**: [github.com/zamai-ai](https://github.com/zamai-ai)
192
-
193
- ## 🏷️ Citation
194
-
195
- If you use this model in your research or applications, please cite:
196
-
197
- ```bibtex
198
- @misc{zamai-zamai-liama3-pashto-2024,
199
- title={ZamAI-LIama3-Pashto: Advanced LLaMA-3 model with enhanced Pashto language capabilities},
200
- author={ZamAI Team},
201
- year={2024},
202
- url={https://huggingface.co/tasal9/ZamAI-LIama3-Pashto},
203
- note={ZamAI Pro Models Strategy - Multilingual AI Platform}
204
- }
205
- ```
206
-
207
- ## πŸ“„ License & Terms
208
-
209
- This model is licensed under the MIT License. See [LICENSE](LICENSE) for more details.
210
-
211
- ### Usage Terms:
212
- - βœ… Commercial use allowed
213
- - βœ… Modification allowed
214
- - βœ… Distribution allowed
215
- - βœ… Private use allowed
216
- - ⚠️ Attribution required
217
-
218
- ## πŸ”— Related Models
219
 
220
- Explore other models in the ZamAI collection:
221
 
222
- - [ZamAI-Mistral-7B-Pashto](https://huggingface.co/tasal9/ZamAI-Mistral-7B-Pashto)
223
- - [ZamAI-Phi-3-Mini-Pashto](https://huggingface.co/tasal9/ZamAI-Phi-3-Mini-Pashto)
224
- - [ZamAI-Whisper-v3-Pashto](https://huggingface.co/tasal9/ZamAI-Whisper-v3-Pashto)
225
- - [Multilingual-ZamAI-Embeddings](https://huggingface.co/tasal9/Multilingual-ZamAI-Embeddings)
226
- - [pashto-base-bloom](https://huggingface.co/tasal9/pashto-base-bloom)
227
 
228
  ---
229
 
230
  **Part of the ZamAI Pro Models Strategy - Transforming AI for Multilingual Applications** 🌟
231
 
232
- *Last Updated: 2025-07-05 21:08:08 UTC*
233
- *Model Card Version: 1.0*
 
8
  - llama3
9
  - pashto
10
  - advanced-llm
11
+ - multilingual
12
  - conversation
13
  base_model: meta-llama/Meta-Llama-3-8B-Instruct
14
  pipeline_tag: text-generation
15
  datasets:
16
  - tasal9/Pashto-Dataset-Creating-Dataset
 
 
 
 
 
17
  ---
18
 
19
  # ZamAI-LIama3-Pashto
 
29
  - 🌐 **Multilingual**: Optimized for Pashto and English
30
  - ⚑ **High Performance**: Optimized for production deployment
31
  - πŸ”’ **Secure**: Enterprise-grade security and privacy
 
 
 
 
 
 
 
 
 
 
32
 
33
  ## πŸ“š Usage
34
 
35
+ ### Basic Usage with Transformers
36
 
37
  ```python
38
  from transformers import AutoTokenizer, AutoModel
39
 
 
40
  tokenizer = AutoTokenizer.from_pretrained("tasal9/ZamAI-LIama3-Pashto")
41
  model = AutoModel.from_pretrained("tasal9/ZamAI-LIama3-Pashto")
42
 
 
46
  outputs = model(**inputs)
47
  ```
48
 
49
+ ### Usage with Hugging Face Inference API
50
 
51
  ```python
52
  from huggingface_hub import InferenceClient
53
 
54
  client = InferenceClient(token="your_hf_token")
55
 
 
56
  response = client.text_generation(
57
  model="tasal9/ZamAI-LIama3-Pashto",
58
  prompt="Your prompt here",
59
+ max_new_tokens=200
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
60
  )
61
  ```
62
 
63
+ ## πŸ”§ Technical Details
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
64
 
65
+ - **Model Type**: text-generation
66
+ - **Base Model**: meta-llama/Meta-Llama-3-8B-Instruct
67
+ - **Languages**: Pashto (ps), English (en)
68
+ - **License**: MIT
69
+ - **Training**: Fine-tuned on Pashto educational and cultural content
70
 
71
+ ## πŸš€ Applications
72
 
73
+ This model powers:
74
+ - **ZamAI Educational Platform**: Pashto language tutoring
75
+ - **Business Automation**: Document processing and analysis
76
+ - **Voice Assistants**: Natural language understanding
77
+ - **Cultural Preservation**: Supporting Pashto language technology
78
 
79
+ ## πŸ“ž Support
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
80
 
81
+ For support and integration assistance:
82
  - πŸ“§ **Email**: [email protected]
83
  - 🌐 **Website**: [zamai.ai](https://zamai.ai)
84
+ - πŸ’¬ **Community**: [ZamAI Community](https://community.zamai.ai)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
85
 
86
+ ## πŸ“„ License
87
 
88
+ Licensed under the MIT License.
 
 
 
 
89
 
90
  ---
91
 
92
  **Part of the ZamAI Pro Models Strategy - Transforming AI for Multilingual Applications** 🌟
93
 
94
+ *Updated: 2025-07-05 21:29:15 UTC*