rifatSDAS commited on
Commit
689e0fd
Β·
1 Parent(s): f9aac4c

Update README

Browse files
Files changed (1) hide show
  1. README.md +34 -17
README.md CHANGED
@@ -28,23 +28,37 @@ short_description: GeoAI Coding Agent - Geospatial AI Coding Assistant"
28
 
29
  # 🌍 GeoAI Coding Agent
30
 
31
- A **Geospatial AI Coding Assistant** powered by `Qwen/Qwen2.5-Coder-7B-Instruct` via HuggingFace Inference API.
32
 
33
- Specialized in **GDAL/OGR**, **Rasterio**, **GeoPandas**, **xarray**, and geospatial development across multiple programming languages.
34
 
35
  ![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)
36
- ![Gradio](https://img.shields.io/badge/Gradio-4.19+-orange.svg)
37
  ![License](https://img.shields.io/badge/License-AGPL--3.0-green.svg)
38
 
39
  ## ✨ Features
40
 
 
41
  - **πŸ—ΊοΈ Geospatial Expertise**: Deep knowledge of GDAL, Rasterio, GeoPandas, PyProj, xarray, and rioxarray
 
42
  - **πŸ’» Multi-Language Support**: Python, Java, C/C++, JavaScript, TypeScript, Rust
43
- - **πŸ“₯ Download Options**: Export responses as Markdown, Jupyter Notebooks, or code files
44
  - **🎨 Code Editor Style UI**: Syntax highlighting with dark theme
45
- - **πŸ”’ BYOT (Bring Your Own Token)**: Uses your HuggingFace API token for inference
46
  - **⚑ Streaming Responses**: Real-time token streaming for better UX
47
 
 
 
 
 
 
 
 
 
 
 
 
 
 
48
  ## πŸš€ Quick Start
49
 
50
  ### Local Development
@@ -122,22 +136,25 @@ geoai-coding-agent/
122
 
123
  Key settings in `config.py`:
124
 
125
- | Parameter | Default | Description |
126
- | ---------------- | -------------------------------- | ------------------------------------------- |
127
- | `MODEL_ID` | `Qwen/Qwen2.5-Coder-7B-Instruct` | HuggingFace model |
128
- | `MAX_NEW_TOKENS` | `2048` | Maximum response length |
129
- | `TEMPERATURE` | `0.3` | Sampling temperature (lower = more focused) |
130
- | `TOP_P` | `0.9` | Nucleus sampling threshold |
 
131
 
132
  ## πŸ”‘ API Token
133
 
134
- This application requires a **HuggingFace API token** for inference. This design:
135
- - βœ… Keeps the Space free (no server-side costs)
136
- - βœ… Prevents token limit overflow
137
- - βœ… Gives users control over their usage
138
 
139
  Get your free token at: [huggingface.co/settings/tokens](https://huggingface.co/settings/tokens)
140
 
 
 
141
  ## πŸ› οΈ Supported Languages
142
 
143
  | Language | Extension | Use Case |
@@ -158,8 +175,8 @@ Get your free token at: [huggingface.co/settings/tokens](https://huggingface.co/
158
  ## πŸ™ Acknowledgments
159
 
160
  - Inspired by [GeoAI-Assistance-Ext](https://github.com/rifatSDAS/GeoAI-Assistance-Ext) VS Code Extension
161
- - Powered by [Qwen2.5-Coder](https://huggingface.co/Qwen/Qwen2.5-Coder-7B-Instruct)
162
- - Built with [Gradio](https://gradio.app/) and [HuggingFace Inference API](https://huggingface.co/inference-api)
163
 
164
  ## About the Developer
165
 
 
28
 
29
  # 🌍 GeoAI Coding Agent
30
 
31
+ A **Geospatial AI Coding Assistant** powered by multiple LLMs via HuggingFace Inference Providers.
32
 
33
+ Specialized in **GDAL/OGR**, **Rasterio**, **GeoPandas**, **xarray**, and geospatial development across multiple programming languages. Designed for **beginner and intermediate learners** with educational explanations.
34
 
35
  ![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)
36
+ ![Gradio](https://img.shields.io/badge/Gradio-6.3+-orange.svg)
37
  ![License](https://img.shields.io/badge/License-AGPL--3.0-green.svg)
38
 
39
  ## ✨ Features
40
 
41
+ - **πŸ€– Multiple AI Models**: Choose from 6 different models (DeepSeek, Kimi, Llama, MiniMax, GLM, Mistral)
42
  - **πŸ—ΊοΈ Geospatial Expertise**: Deep knowledge of GDAL, Rasterio, GeoPandas, PyProj, xarray, and rioxarray
43
+ - **πŸ“š Educational Focus**: Responses include code explanations, step-by-step logic, and tips for beginners
44
  - **πŸ’» Multi-Language Support**: Python, Java, C/C++, JavaScript, TypeScript, Rust
45
+ - **πŸ“₯ Download Options**: Export responses as Markdown or code files
46
  - **🎨 Code Editor Style UI**: Syntax highlighting with dark theme
 
47
  - **⚑ Streaming Responses**: Real-time token streaming for better UX
48
 
49
+ ## πŸ€– Available Models
50
+
51
+ | Model | Provider | Speed | Best For |
52
+ |-------|----------|-------|----------|
53
+ | **DeepSeek V3.2** | Novita | Medium | Complex geospatial tasks, detailed explanations |
54
+ | **Kimi K2 Instruct** | Novita | Medium | General coding, good balance |
55
+ | **Llama 3.1 8B** | Novita | Fast | Quick answers, simple tasks |
56
+ | **MiniMax M2.1** | Novita | Medium | Creative solutions |
57
+ | **GLM 4.7 Flash** | Novita | Fast | Fast responses, basic tasks |
58
+ | **Mistral 7B v0.2** | Featherless | Fast | Quick prototyping |
59
+
60
+ > πŸ’‘ **Tip**: Larger models provide better results but take longer. Smaller models are faster for simple queries.
61
+
62
  ## πŸš€ Quick Start
63
 
64
  ### Local Development
 
136
 
137
  Key settings in `config.py`:
138
 
139
+ | Parameter | Default | Description |
140
+ | ------------------ | ----------------- | ------------------------------------------- |
141
+ | `DEFAULT_MODEL` | `DeepSeek V3.2` | Default model selection |
142
+ | `MAX_NEW_TOKENS` | `2048` | Maximum response length |
143
+ | `TEMPERATURE` | `0.3` | Sampling temperature (lower = more focused) |
144
+ | `TOP_P` | `0.9` | Nucleus sampling threshold |
145
+ | `AVAILABLE_MODELS` | (see table above) | Dictionary of available models & providers |
146
 
147
  ## πŸ”‘ API Token
148
 
149
+ This application requires a **HuggingFace API token** with Inference Provider permissions.
150
+
151
+ **Required permissions**:
152
+ - βœ… Make calls to Inference Providers
153
 
154
  Get your free token at: [huggingface.co/settings/tokens](https://huggingface.co/settings/tokens)
155
 
156
+ For HuggingFace Spaces deployment, add the token as a **Secret** named `HF_TOKEN` in Space Settings.
157
+
158
  ## πŸ› οΈ Supported Languages
159
 
160
  | Language | Extension | Use Case |
 
175
  ## πŸ™ Acknowledgments
176
 
177
  - Inspired by [GeoAI-Assistance-Ext](https://github.com/rifatSDAS/GeoAI-Assistance-Ext) VS Code Extension
178
+ - Powered by multiple LLMs via [HuggingFace Inference Providers](https://huggingface.co/docs/huggingface_hub/guides/inference)
179
+ - Built with [Gradio](https://gradio.app/)
180
 
181
  ## About the Developer
182