Metadata-Version: 2.4
Name: burmesegpt
Version: 0.1.11
Summary: BurmeseGPT is a Burmese-first AI ecosystem package, including Padauk, an agentic small language model built for tool use, function calling, and local deployment.
Project-URL: Homepage, https://www.waiyannyeinnaing.com/
Project-URL: Padauk, https://www.waiyannyeinnaing.com/projects/padauk
Project-URL: Source, https://github.com/WaiYanNyeinNaing/burmese-gpt-pypi-api
Project-URL: Issues, https://github.com/WaiYanNyeinNaing/burmese-gpt-pypi-api/issues
Project-URL: Hugging Face, https://huggingface.co/WYNN747/padauk-burmese-agentic-llm
Project-URL: Documentation, https://github.com/WaiYanNyeinNaing/burmese-gpt-pypi-api/blob/main/docs/README.md
Author-email: "Dr. Wai Yan Nyein Naing" <waiyan.nn18@gmail.com>
License: MIT
Keywords: agentic ai,burmese ai,burmese gpt,burmese llm,function calling,local llm,myanmar ai,padauk,small language model,tool calling
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: huggingface-hub>=0.24.0
Requires-Dist: requests>=2.31.0
Provides-Extra: dev
Requires-Dist: build>=1.2.1; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: twine>=5.0.0; extra == 'dev'
Provides-Extra: full
Requires-Dist: llama-cpp-python[server]>=0.2.90; extra == 'full'
Requires-Dist: openai>=1.30.0; extra == 'full'
Provides-Extra: openai
Requires-Dist: openai>=1.30.0; extra == 'openai'
Provides-Extra: server
Requires-Dist: llama-cpp-python[server]>=0.2.90; extra == 'server'
Description-Content-Type: text/markdown

# BurmeseGPT

BurmeseGPT is an open Burmese-first AI ecosystem created by Dr. Wai Yan Nyein Naing. This Python package is the main package for BurmeseGPT projects, including Padauk, a practical agentic small language model built for Burmese language understanding, tool use, function calling, and local or edge deployment.

## Why BurmeseGPT

Burmese is still a low-resource language in AI, and practical Burmese AI tooling remains limited for many real developer workflows. BurmeseGPT focuses on useful, production-minded, and developer-friendly Burmese AI systems that can run locally and integrate with modern agent and API patterns.

## Related projects

- **Padauk** - Burmese-first agentic language model.
- **Burmese-Coder** - Burmese coding and technical AI direction.
- Future tools and integrations under the BurmeseGPT ecosystem.

## End-User Install And Use

This section is the simple user flow only: install, download, run, and test the local API.

Requirements:

- Python `>=3.10`
- `llama-server` on your `PATH`
- `llama-server --version` should report `8751` or newer, `8833` recommended

```bash
python3.10 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install "burmesegpt[full]"
```

If `python3.10` is not installed, use `python3.11`:

```bash
python3.11 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install "burmesegpt[full]"
```

See `docs/guides/pypi-install-quickstart.md` for the same copy-paste flow.

## Download Model And Run API

First, confirm the runtime is available from your shell:

```bash
llama-server --version
```

```bash
burmesegpt download --quant q8_0
burmesegpt serve --quant q8_0 --host 127.0.0.1 --port 8000
```

Keep that terminal running while you test requests.

## Test With API Call (curl)

```bash
curl http://127.0.0.1:8000/v1/models
```

```bash
curl http://127.0.0.1:8000/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-no-key-required" \
  -d '{
    "model": "padauk-agent",
    "messages": [{"role": "user", "content": "မင်္ဂလာပါ"}]
  }'
```

## Test With OpenAI Agents SDK

```bash
python -m pip install openai-agents
```

```python
import asyncio

from openai import AsyncOpenAI
from agents import Agent, Runner, set_default_openai_api, set_default_openai_client, set_tracing_disabled

set_tracing_disabled(True)
set_default_openai_api("chat_completions")
set_default_openai_client(
    AsyncOpenAI(base_url="http://127.0.0.1:8000/v1", api_key="sk-no-key-required")
)

padauk = Agent(
    name="Padauk Assistant",
    model="padauk-agent",
    instructions="Reply in Burmese by default.",
)

async def main() -> None:
    result = await Runner.run(padauk, input="မင်္ဂလာပါ")
    print(result.final_output)

asyncio.run(main())
```

## Maintainer Release Validation

If you are packaging or rebuilding the model, use these maintainer-only guides:

- `docs/guides/pypi-release-guide.md`
- `docs/guides/hf-to-gguf-quantization-guide.md`
- `docs/guides/gemma4-shared-kv-rca.md`

## Links

- Website: [https://www.waiyannyeinnaing.com/](https://www.waiyannyeinnaing.com/)
- Padauk: [https://www.waiyannyeinnaing.com/projects/padauk](https://www.waiyannyeinnaing.com/projects/padauk)
- Source: [https://github.com/WaiYanNyeinNaing/burmese-gpt-pypi-api](https://github.com/WaiYanNyeinNaing/burmese-gpt-pypi-api)
- Hugging Face source repo: [https://huggingface.co/WYNN747/Burmese-GPT-Padauk](https://huggingface.co/WYNN747/Burmese-GPT-Padauk)
- Hugging Face GGUF repo: [https://huggingface.co/WYNN747/padauk-burmese-agentic-llm](https://huggingface.co/WYNN747/padauk-burmese-agentic-llm)
