deep-reinforce commited on
Commit
c2e1703
·
verified ·
1 Parent(s): 013ba12

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +85 -10
README.md CHANGED
@@ -311,47 +311,122 @@ Ornith-1.0-35B excels in tool-calling and agentic coding capabilities.
311
  Because Ornith-1.0-35B exposes an OpenAI-compatible endpoint with tool calling, it works out of the box with standard agent frameworks. Below is a minimal example that connects Ornith-1.0-35B to tools through an MCP server.
312
 
313
  ```python
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
314
 
 
 
 
 
 
 
 
 
315
  ```
316
 
317
  **Examples of using Ornith with agent harness:**
318
 
319
  #### Hermes Agent
320
  ```bash
321
-
 
 
 
322
  ```
323
 
324
- #### OpenHands
 
325
  ```bash
 
 
 
 
326
 
 
 
327
  ```
328
 
329
- #### llama.cpp / Ollama
330
- ```bash
331
 
 
 
 
 
 
332
  ```
333
 
334
  #### Unsloth Studio
335
 
336
  ```bash
337
-
 
 
 
 
 
 
 
 
338
  ```
339
 
340
- #### OpenClaw
341
-
342
  ```bash
 
343
 
344
- ```
 
 
 
345
 
 
 
 
346
 
347
  ### Coding CLIs
348
 
349
  Ornith-1.0-35B is optimized for terminal-based coding agents. Point any OpenAI-compatible coding CLI at your Ornith-1.0-35B endpoint (set `OPENAI_BASE_URL` and `OPENAI_API_KEY`) to understand large codebases, automate tedious work, and ship faster.
350
 
351
-
352
  #### OpenCode
353
  ```bash
354
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
355
  ```
356
 
357
 
 
311
  Because Ornith-1.0-35B exposes an OpenAI-compatible endpoint with tool calling, it works out of the box with standard agent frameworks. Below is a minimal example that connects Ornith-1.0-35B to tools through an MCP server.
312
 
313
  ```python
314
+ import os
315
+ from openai import OpenAI
316
+
317
+ client = OpenAI(
318
+ base_url=os.getenv("OPENAI_BASE_URL", "http://localhost:8000/v1"),
319
+ api_key=os.getenv("OPENAI_API_KEY", "EMPTY"),
320
+ )
321
+
322
+ tools = [
323
+ {
324
+ "type": "function",
325
+ "function": {
326
+ "name": "run_shell",
327
+ "description": "Run a shell command and return its output.",
328
+ "parameters": {
329
+ "type": "object",
330
+ "properties": {
331
+ "command": {"type": "string", "description": "The command to run"}
332
+ },
333
+ "required": ["command"],
334
+ },
335
+ },
336
+ }
337
+ ]
338
+
339
+ messages = [{"role": "user", "content": "List the Python files in the current directory."}]
340
 
341
+ response = client.chat.completions.create(
342
+ model="deepreinforce-ai/Ornith-1.0-35B",
343
+ messages=messages,
344
+ tools=tools,
345
+ temperature=0.6,
346
+ top_p=0.95,
347
+ )
348
+ print(response.choices[0].message)
349
  ```
350
 
351
  **Examples of using Ornith with agent harness:**
352
 
353
  #### Hermes Agent
354
  ```bash
355
+ # Hermes talks to any OpenAI-compatible endpoint — point it at your Ornith server.
356
+ export OPENAI_BASE_URL="http://localhost:8000/v1"
357
+ export OPENAI_API_KEY="EMPTY"
358
+ export MODEL="deepreinforce-ai/Ornith-1.0-35B"
359
  ```
360
 
361
+
362
+ #### Atomic.chat/ Ollama / llama.cpp
363
  ```bash
364
+ # Both runtimes load a GGUF build of Ornith (publish one at deepreinforce-ai/Ornith-1.0-35B-GGUF).
365
+
366
+ # llama.cpp — serve an OpenAI-compatible API on port 8000.
367
+ llama-server -hf deepreinforce-ai/Ornith-1.0-35B-GGUF --port 8000 -c 262144
368
 
369
+ # Ollama — pull and chat with the same GGUF straight from Hugging Face.
370
+ ollama run hf.co/deepreinforce-ai/Ornith-1.0-35B-GGUF
371
  ```
372
 
373
+ #### OpenClaw
 
374
 
375
+ ```bash
376
+ # OpenClaw talks to any OpenAI-compatible endpoint — point it at your Ornith server.
377
+ export OPENAI_BASE_URL="http://localhost:8000/v1"
378
+ export OPENAI_API_KEY="EMPTY"
379
+ export OPENAI_MODEL="deepreinforce-ai/Ornith-1.0-35B"
380
  ```
381
 
382
  #### Unsloth Studio
383
 
384
  ```bash
385
+ pip install unsloth
386
+
387
+ # Load Ornith for fast local inference or fine-tuning (Python):
388
+ # from unsloth import FastLanguageModel
389
+ # model, tokenizer = FastLanguageModel.from_pretrained(
390
+ # "deepreinforce-ai/Ornith-1.0-35B",
391
+ # max_seq_length=262144,
392
+ # load_in_4bit=True,
393
+ # )
394
  ```
395
 
396
+ #### OpenHands
 
397
  ```bash
398
+ pip install openhands-ai
399
 
400
+ # OpenHands routes through LiteLLM; the "openai/" prefix selects the OpenAI-compatible path.
401
+ export LLM_MODEL="openai/deepreinforce-ai/Ornith-1.0-35B"
402
+ export LLM_BASE_URL="http://localhost:8000/v1"
403
+ export LLM_API_KEY="EMPTY"
404
 
405
+ # Launch the CLI (or run the official OpenHands Docker image with the same env vars).
406
+ openhands
407
+ ```
408
 
409
  ### Coding CLIs
410
 
411
  Ornith-1.0-35B is optimized for terminal-based coding agents. Point any OpenAI-compatible coding CLI at your Ornith-1.0-35B endpoint (set `OPENAI_BASE_URL` and `OPENAI_API_KEY`) to understand large codebases, automate tedious work, and ship faster.
412
 
 
413
  #### OpenCode
414
  ```bash
415
+ # Register your local Ornith endpoint as a provider in ~/.config/opencode/opencode.json:
416
+ #
417
+ # {
418
+ # "$schema": "https://opencode.ai/config.json",
419
+ # "provider": {
420
+ # "ornith": {
421
+ # "npm": "@ai-sdk/openai-compatible",
422
+ # "name": "Ornith (local)",
423
+ # "options": { "baseURL": "http://localhost:8000/v1", "apiKey": "EMPTY" },
424
+ # "models": { "deepreinforce-ai/Ornith-1.0-35B": { "name": "Ornith-1.0-35B" } }
425
+ # }
426
+ # }
427
+ # }
428
+
429
+ opencode
430
  ```
431
 
432