Instructions to use cortexso/athene with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Notebooks
Google Colab
Kaggle
Local Apps Settings

How to use cortexso/athene with llama.cpp:

Install (macOS, Linux)

curl -LsSf https://llama.app/install.sh | sh
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf cortexso/athene:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf cortexso/athene:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf cortexso/athene:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf cortexso/athene:Q4_K_M

Use pre-built binary

# Download pre-built binary from:
# https://github.com/ggerganov/llama.cpp/releases
# Start a local OpenAI-compatible server with a web UI:
./llama-server -hf cortexso/athene:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf cortexso/athene:Q4_K_M

Build from source code

git clone https://github.com/ggerganov/llama.cpp.git
cd llama.cpp
cmake -B build
cmake --build build -j --target llama-server llama-cli
# Start a local OpenAI-compatible server with a web UI:
./build/bin/llama-server -hf cortexso/athene:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf cortexso/athene:Q4_K_M

Use Docker

docker model run hf.co/cortexso/athene:Q4_K_M

LM Studio
Jan

vLLM

How to use cortexso/athene with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "cortexso/athene"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "cortexso/athene",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/cortexso/athene:Q4_K_M

Ollama
How to use cortexso/athene with Ollama:
```
ollama run hf.co/cortexso/athene:Q4_K_M
```
Unsloth Desktop

How to use cortexso/athene with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf cortexso/athene:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @earendil-works/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "cortexso/athene:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use cortexso/athene with Docker Model Runner:
```
docker model run hf.co/cortexso/athene:Q4_K_M
```

Lemonade

How to use cortexso/athene with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull cortexso/athene:Q4_K_M

Run and chat with the model

lemonade run user.athene-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use cortexso/athene with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf cortexso/athene:Q4_K_M

Configure Hermes

# Install Hermes:
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
hermes setup
# Point Hermes at the local server:
hermes config set model.provider custom
hermes config set model.base_url http://127.0.0.1:8080/v1
hermes config set model.default cortexso/athene:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use cortexso/athene with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf cortexso/athene:Q4_K_M

Configure OpenClaw

# Install OpenClaw:
npm install -g openclaw@latest
# Register the local server and set it as the default model:
openclaw onboard --non-interactive --mode local \
  --auth-choice custom-api-key \
  --custom-base-url http://127.0.0.1:8080/v1 \
  --custom-model-id "cortexso/athene:Q4_K_M" \
  --custom-provider-id llama-cpp \
  --custom-compatibility openai \
  --custom-text-input \
  --accept-risk \
  --skip-health

Run OpenClaw

openclaw agent --local --agent main --message "Hello from Hugging Face"

HoangHa commited on Nov 29, 2024

Commit

111dd59

verified ·

1 Parent(s): cb14d40

Create README.md

Browse files

Files changed (1) hide show

README.md +35 -0

README.md ADDED Viewed

	@@ -0,0 +1,35 @@

+---
+license: other
+---
+## Overview
+## Variants
+| No | Variant | Cortex CLI command |
+| --- | --- | --- |
+| 1 | [gguf] | `cortex run ` |
+## Use it with Jan (UI)
+1. Install **Jan** using [Quickstart](https://jan.ai/docs/quickstart)
+2. Use in Jan model Hub:
+    ```
+    cortexhub/
+    ```
+## Use it with Cortex (CLI)
+1. Install **Cortex** using [Quickstart](https://cortex.jan.ai/docs/quickstart)
+2. Run the model with command:
+    ```
+    cortex run opencoder
+    ```
+## Credits
+- **Author:**
+- **Converter:** [Homebrew]
+- **Original License:** [Licence]
+- **Papers:** [Paper]