Update README.md

Browse files

Files changed (1) hide show

README.md +83 -82

README.md CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
-license: other
-license_name: proprietary
-license_link: LICENSE
 ---
 <!-- ================= Social Links ================= -->
@@ -25,124 +25,125 @@ license_link: LICENSE
 ---
-# 🚀 JumpLander Coder 32B 🇮🇷
-**Advanced Code-Generation LLM — optimized for Persian-speaking developers**
-**جامپلندر کُدر 32B — مدل تولید کُد پیشرفته برای توسعه‌دهندگان فارسی‌زبان**
-_This is a documentation-only release. Model weights will be published in the upcoming open-source launch._
-_این فقط نسخهٔ مستندسازی است. وزن‌های مدل به زودی در انتشار متن‌باز ارائه خواهند شد._
 ---
-## 🌟 Overview | مروری بر پروژه
-JumpLander Coder 32B is a high-performance, bilingual (English–Persian) code-generation LLM designed to deliver:
-JumpLander Coder 32B یک مدل تولید کُد با عملکرد بالا و دو زبانه (انگلیسی و فارسی) است که طراحی شده تا:
-- High-quality, executable code generation ⚡ — تولید کدی با کیفیت بالا و قابل اجرا
-- Multi-file reasoning & architecture-level analysis 🧩 — تحلیل سطح معماری و استدلال در چند فایل
-- Security-aware and refactoring-optimized outputs 🛡️ — خروجی‌هایی با آگاهی امنیتی و بهینه‌شده برای بازسازی کد
-- Enhanced usability for Persian-speaking developers 🇮🇷 — تجربهٔ بهتر برای توسعه‌دهندگان فارسی‌زبان
-> ⚠️ Model weights and tokenizer are **not** released yet.
-> ⚠️ وزن‌های مدل و توکنایزر هنوز منتشر نشده‌اند.
 ---
-## 📊 Current Status | وضعیت فعلی
-- ✔ Documentation available — مستندسازی موجود است
-- ✔ Benchmarks included — بنچمارک‌ها افزوده شده‌اند
-- ❌ No model weights available yet — هنوز وزنی برای مدل منتشر نشده است
-- 🚀 Future open-source release planned — انتشار متن‌باز در آینده برنامه‌ریزی شده است
-:contentReference[oaicite:1]{index=1}
 ---
-## 🗂 Local-Use & Software Distribution | استفادهٔ محلی و توزیع نرم‌افزار
-> We are building a dedicated desktop-/server-software (JumpLander App) that allows users to **download** the model weights and run the model **locally** on their machine.
-> ما در حال ساخت نرم‌افزار اختصاصی (JumpLander App) هستیم که کاربران بتوانند وزن مدل را دانلود کرده و مدل را **به صورت محلی** روی سیستم خود اجرا کنند.
-**Important note | نکتهٔ مهم:**
-- Until the local package is released, you can test the model via our website/demo.
-  تا زمان انتشار بستهٔ محلی، می‌توانید از طریق وب‌سایت/دمو مدل را آزمایش کنید.
-- When local usage is available, the flow will be:
-  1. Download model weights + checksum + signature
-  2. Verify integrity locally (SHA-256, PGP)
-  3. Load model via JumpLander App or CLI
-  4. Start coding locally — offline or online
-**جریان کار زمانی که قابلیت لوکال آماده شود:**
-1. دانلود وزن‌های مدل + چکسام + امضای دیجیتال
-2. بررسی صحت و یکپارچگی محلی (SHA-256 و PGP)
-3. اجرا از ��ریق JumpLander App یا CLI
-4. شروع به کدنویسی به صورت محلی — آفلاین یا آنلاین
 ---
-## 🧪 Benchmarks (Prototype) | بنچمارک‌ها (نسخهٔ اولیه)
-| Task | Score | Notes |
-|------|-------|--------|
-| **HumanEval** | **72%** | Strong execution accuracy :contentReference[oaicite:2]{index=2} |
-| **Repo-level Q&A** | High | Multi-file reasoning stability :contentReference[oaicite:3]{index=3} |
-| **Persian Instruction Following** | **Excellent** | Bilingual optimization :contentReference[oaicite:4]{index=4} |
 ---
-## 💡 Why Choose JumpLander Coder 32B? | چرا JumpLander انتخاب خوبی است؟
-> ### 🧠 Stronger multi-file reasoning
-> Built for architecture-level understanding and repository-wide analysis.
-> ### 🇮🇷 Optimized for Persian-speaking developers
-> Enhanced bilingual dataset and instruction tuning for real-world Persian workflows.
-> ### 🛡️ Secure-by-design coding
-> Refactoring, patch suggestions, and safe coding patterns included by design.
-> ### ⚡ Developer-centric workflow
-> SDK, CLI, test-generation, repo-analysis, and future IDE integrations.
-:contentReference[oaicite:5]{index=5}
 ---
-## 🎯 Intended Use Cases | موارد کاربرد پیشنهادی
-- Rapid application scaffolding — ساخت سریع اپلیکیشن
-- Full repository refactoring — بازسازی کاملِ ریپوزیتوری
-- Code debugging & architecture inspection — دیباگ کد و بازبینی معماری
-- Documentation and API spec generation — تولید مستندات و مشخصات API
-- Teaching and learning programming (English + Persian) — آموزش و یادگیری برنامه‌نویسی (انگلیسی + فارسی)
-> ⚠️ Not intended for unreviewed deployment in safety-critical systems.
-> ⚠️ برای استفاده بدون بازبینی در سیستم‌های حساس به امنیت توصیه نمی‌شود.
-:contentReference[oaicite:6]{index=6}
 ---
-## 🗂 Repository Structure | ساختار ریپوزیتوری
-- `README.md` — project introduction — معرفی پروژه
-- `LICENSE` — proprietary license placeholder — محل قرارگیری مجوز اختصاصی
-- (بزودی) `models/` — شاخهٔ وزن‌ها و فایل‌های اعتبارسنجی
-- (بزودی) `scripts/` — اسکریپت‌های ارزیابی، تست، نصب
 ---
-## 🛠 Planned Capabilities | قابلیت‌های برنامه‌ریزی شده
 - Repository-wide code generation
 - Multi-language support: Python, JS/TS, Go, Rust, Java, C/C++, Bash, SQL
-- Refactoring automation & patch suggestions
-- Test generation (unit, integration, regression)
-- Long-context reasoning
-- CLI, SDK, and IDE extensions
-:contentReference[oaicite:7]{index=7}
 ---
-## 💻 Example Usage (Future API) | نمونهٔ استفاده (آینده)
 ```python
 from jumplander_sdk import JumplanderClient
 client = JumplanderClient(api_key="YOUR_KEY")
-# Scaffold a FastAPI app with JWT + PostgreSQL
 project = client.scaffold(
-    "Create a FastAPI service with JWT auth and PostgreSQL integration",
     language="python"
 )
 project.save("./generated_app")
 # Refactor an existing repository
-patches = client.refactor("./myrepo", intent="improve architecture and modularity")
 client.apply_patches(patches)

 ---
+license: other
+license_name: proprietary
+license_link: LICENSE
 ---
 <!-- ================= Social Links ================= -->
 ---
+# 🚀 JumpLander Coder 32B
+**Advanced Code-Generation LLM — optimized for English & Persian workflows**
+🇮🇷 *چند خط توضیح فارسی:*
+این مدل برای توسعه‌دهندگان ایرانی طراحی شده و نسخه آنلاین آن در سایت فعال است.
+نسخه‌ی لوکال فقط از طریق نرم‌افزار رسمی JumpLander ارائه خواهد شد.
+وزن‌های مدل عمومی نیستند و تنها در قالب نرم‌افزار قابل استفاده می‌باشند.
 ---
+## 🌟 Overview
+JumpLander Coder 32B is a high-performance, bilingual (English–Persian) code-generation LLM built for advanced programming tasks, repository-wide reasoning, and architecture-level understanding.
+This release provides documentation, benchmarks, design goals, and usage guidelines.
+**Model weights are not publicly distributed.**
+Local access will be provided exclusively through the official JumpLander desktop/server application.
 ---
+## 📊 Current Status
+<img src="https://cdn-uploads.huggingface.co/production/uploads/69204763af796f2f22ad9f49/A8r0WUkLpEhDAh7Z8Xajx.jpeg" width="600"/>
+- ✔ Documentation available
+- ✔ Prototype benchmarks included
+- ✔ Online demo available on the website
+- ❌ Weights are *not* public
+- 🔒 Local model execution will be provided only via official software
 ---
+# 🧪 Benchmarks (Prototype)
+| Task | Score | Notes |
+|------|-------|--------|
+| **HumanEval** | **72%** | Strong execution accuracy |
+| **Repo-level Q&A** | High | Stable multi-file reasoning |
+| **Persian Instruction Following** | **Excellent** | Optimized bilingual performance |
 ---
+# 📦 Model Comparison (Prototype Benchmarks)
+| Model | Params | HumanEval | Multi-file Reasoning | Persian Support | Speed (tok/s) | Availability |
+|------|--------|-----------|------------------------|------------------|----------------|--------------|
+| **JumpLander Coder 32B** | 32B | **72%** | ✔ Strong | **Excellent** | 34 | Local-only via app |
+| Qwen2.5-Coder 32B | 32B | 75% | Medium | Weak | 32 | Open-source |
+| DeepSeek-Coder 33B | 33B | 79% | Strong | Weak | 29 | Open-source |
+| StarCoder2 15B | 15B | 63% | Limited | Weak | **45** | Open-source |
+| Llama-3.1 70B | 70B | **82%** | Strong | Weak | 20 | Open-source |
 ---
+# 💡 Why JumpLander Coder 32B?
+> ### 🧠 Multi-file reasoning
+> Designed for architecture-level understanding and full-repository analysis.
+> ### 🇮🇷 Persian-optimized workflow
+> Tuned for real Persian programming scenarios and instruction patterns.
+> ### 🛡️ Secure-by-design outputs
+> Refactoring logic, patch suggestions, and safe coding guidelines included.
+> ### ⚡ Developer-focused ecosystem
+> Future SDK, CLI tools, and integrated analysis modules.
 ---
+## 🗂 Local Execution (Official Software Only)
+Local execution of the model will be provided through the **JumpLander App**, enabling:
+- Secure local model loading
+- Offline and online operation modes
+- Integrated coding environment
+- Automatic model updates
+- Full repository understanding features
+**Note:**
+Weights will *not* be downloadable manually.
+They are packaged, encrypted, and tied to the official software.
 ---
+## 🎯 Use Cases
+- Application scaffolding
+- Repository-wide refactoring
+- Debugging & architecture inspection
+- Documentation and API specification
+- Programming education (EN + FA)
 ---
+## 🛠 Planned Capabilities
 - Repository-wide code generation
 - Multi-language support: Python, JS/TS, Go, Rust, Java, C/C++, Bash, SQL
+- Long-context reasoning (hundreds of thousands of tokens)
+- Test generation: unit, integration, regression
+- IDE extensions (VS Code + JetBrains)
+- Full SDK + CLI tools
 ---
+## 💻 Example Usage (Future API)
 ```python
 from jumplander_sdk import JumplanderClient
 client = JumplanderClient(api_key="YOUR_KEY")
+# Scaffold a FastAPI app
 project = client.scaffold(
+    "Create a FastAPI service with JWT and PostgreSQL",
     language="python"
 )
 project.save("./generated_app")
 # Refactor an existing repository
+patches = client.refactor("./myrepo", intent="improve structure")
 client.apply_patches(patches)