amkyawdev commited on
Commit
2f148e5
·
verified ·
1 Parent(s): 9d4a600

Add: Knowledge Base, Data Files, API Integration, Error Handling, Type Hints

Browse files
Files changed (1) hide show
  1. README.md +36 -125
README.md CHANGED
@@ -1,129 +1,40 @@
1
- # 🧑‍💻 Burme-Coder-Max
2
-
3
- Expert Myanmar AI coding agent - မြန်မာဘာသာဖြင့် ကုဒ်ရေးသင်တန်း AI Agent
4
-
5
- ## 🎯 အဓိက လုပ်ဆောင်ချက်များ
6
-
7
- - **🗣️ မြန်မာဘာသာ**: မြန်မာစာနဲ့ ကုဒ်ရေးသင်တန်း ပေးနိုင်
8
- - **💻 Code Examples**: Python, JavaScript, TypeScript, SQL, Go, Rust နဲ့ အခြားဘာသာစကားများ
9
- - **✨ Terminal Animations**: Spinners, progress bars, particle effects
10
- - **📚 Knowledge Base**: Local markdown files + web updates
11
- - **🔄 Auto Update**: Web scraping ကနေ knowledge update
12
-
13
- ## 📦 Installation
14
-
15
- ```bash
16
- pip install burme-coder-max
17
- ```
18
-
19
- သို့မဟုတ် source ကနေ install:
20
-
21
- ```bash
22
- git clone https://github.com/amkyawdev/burme-coder-max.git
23
- cd burme-coder-max
24
- pip install -e .
25
- ```
26
-
27
- ## 🚀 Usage
28
-
29
- ### CLI Mode
30
-
31
- ```bash
32
- burme-coder ask "Python list sorting လုပ်နည်း"
33
- ```
34
-
35
- ### Interactive Mode
36
-
37
- ```bash
38
- burme-coder interactive
39
- ```
40
-
41
- ### Train Mode
42
-
43
- ```bash
44
- burme-coder train --data ./data/trajectories
45
- ```
46
-
47
- ## 📁 Project Structure
48
-
49
- ```
50
- burme-coder-max/
51
- ├── src/
52
- │ ├── core/ # Agent logic
53
- │ ├── cli/ # Command line
54
- │ ├── animations/ # Terminal animations
55
- │ ├── ui/ # User interface
56
- │ ├── knowledge/ # Knowledge base
57
- │ └── utils/ # Utilities
58
- ├── data/
59
- │ ├── knowledge/ # Markdown files
60
- │ └── trajectories/ # Training data
61
- └── tests/ # Unit tests
62
- ```
63
-
64
- ## 🎨 Animations
65
-
66
  ```python
67
- from animations import Spinner, ProgressBar, TypingEffect
68
-
69
- # Spinner
70
- with Spinner("Loading..."):
71
- do_something()
72
-
73
- # Progress Bar
74
- for i in ProgressBar(range(100), description="Processing"):
75
- process(i)
76
- ```
77
-
78
- ## 🙏 Thanking System
79
-
80
- ```python
81
- from ui.thanking import ThankYou, Appreciation
82
-
83
- # Simple thank you
84
- ThankYou.show()
85
-
86
- # Detailed appreciation
87
- Appreciation.show("Python decorator")
88
- ```
89
-
90
- ## 📚 Knowledge Base
91
-
92
- ```python
93
- from knowledge import LocalKB, WebUpdater
94
-
95
- # Local search
96
- kb = LocalKB()
97
- results = kb.search("python decorators")
98
-
99
- # Web update
100
- updater = WebUpdater()
101
- updater.update_from_web()
102
- ```
103
-
104
- ## ⚙️ Configuration
105
-
106
- `.env.example` ကို `.env` အနေဖြင့် ကော်ပြန်ပြင်:
107
-
108
- ```bash
109
- cp .env.example .env
110
- # Then edit .env with your API keys
111
  ```
112
 
113
- ## 🧪 Testing
114
-
115
- ```bash
116
- pytest tests/ -v
117
- ```
118
-
119
- ## 📄 License
120
-
121
- MIT License - အသုံးပြုခွင့်အခ� Free
122
-
123
- ## 👨‍💻 Author
124
-
125
- **amkyawdev** - AI Developer
126
 
127
- - 🌐 Website: https://amkyawdev.com
128
- - 💻 GitHub: https://github.com/amkyawdev
129
- - 🤗 HuggingFace: https://huggingface.co/amkyawdev
 
1
+ ---
2
+ license: mit
3
+ ---
4
+
5
+ # burme-coder-max
6
+
7
+ Burmese (Myanmar) Coding Assistant Dataset for training AI coding models.
8
+
9
+ ## Dataset Information
10
+ - **Total Rows:** 310
11
+ - **Format:** Parquet
12
+ - **Columns:** system, instruction, response
13
+
14
+ ## Topics Covered
15
+ - Python, JavaScript, TypeScript, Go, Rust programming
16
+ - REST API development
17
+ - Database operations
18
+ - DevOps and deployment
19
+ - Data structures and algorithms
20
+ - **Knowledge Base & RAG Systems**
21
+ - **Data File Handling (CSV, JSON, Excel)**
22
+ - **API Integration Patterns**
23
+ - **Error Handling & Custom Exceptions**
24
+ - **Python Type Hints & Type Safety**
25
+ - **Vector Search & Semantic Search**
26
+ - **Dataclasses & Complex Data Models**
27
+ - **Result Pattern & Functional Error Handling**
28
+
29
+ ## Usage
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
  ```python
31
+ from datasets import load_dataset
32
+ ds = load_dataset("amkyawdev/burme-coder-max")
33
+ print(ds['train'][0])
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
34
  ```
35
 
36
+ ## License
37
+ MIT License
 
 
 
 
 
 
 
 
 
 
 
38
 
39
+ ## Author
40
+ amkyawdev