Skip to content

Fix ramalama daemon man page #2934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mmustafasenoglu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix ramalama daemon man page #2934

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 12 additions & 43 deletions docs/ramalama-daemon.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ ramalama\-daemon - run a RamaLama REST server
**ramalama daemon** [*options*] [start|run]

## DESCRIPTION
Inspect the specified AI Model about additional information
like the repository, its metadata and tensor information.
Run a RamaLama REST server as a background daemon. The daemon exposes an
OpenAI-compatible API used to manage and serve AI Models.

## OPTIONS

Expand All @@ -18,57 +18,26 @@ Print usage message
## COMMANDS

#### **start**
pepares to run a new RamaLama REST server so it will be run either inside a RamaLama container or on the host
prepares to run a new RamaLama REST server so it will be run either inside a RamaLama container or on the host

#### **run**
start a new RamaLama REST server

## EXAMPLES

Inspect the smollm:135m model for basic information
Start the daemon (prepares and launches the REST server)
```
$ ramalama inspect smollm:135m
smollm:135m
Path: /var/lib/ramalama/models/ollama/smollm:135m
Registry: ollama
Format: GGUF
Version: 3
Endianness: little
Metadata: 39 entries
Tensors: 272 entries
$ ramalama daemon start
```

Inspect the smollm:135m model for all information in json format
Run the daemon in the foreground
```
$ ramalama inspect smollm:135m --all --json
{
"Name": "smollm:135m",
"Path": "/home/mengel/.local/share/ramalama/models/ollama/smollm:135m",
"Registry": "ollama",
"Format": "GGUF",
"Version": 3,
"LittleEndian": true,
"Metadata": {
"general.architecture": "llama",
"general.base_model.0.name": "SmolLM 135M",
"general.base_model.0.organization": "HuggingFaceTB",
"general.base_model.0.repo_url": "https://huggingface.co/HuggingFaceTB/SmolLM-135M",
...
},
"Tensors": [
{
"dimensions": [
576,
49152
],
"n_dimensions": 2,
"name": "token_embd.weight",
"offset": 0,
"type": 8
},
...
]
}
$ ramalama daemon run
```

Run the daemon on a custom port
```
$ ramalama daemon run --port 8080
```

## SEE ALSO
Expand Down