Skip to content
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.

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

Update the cortex-cpp Readme #1028

Merged
merged 15 commits into from
Aug 30, 2024
Prev Previous commit
Next Next commit
nits
irfanpena committed Aug 26, 2024
commit b444b690d46784c6349b9fa68a27cbc02a2894b9
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@
</p>

<p align="center">
<a href="https://jan.ai/cortex">Documentation</a> - <a href="https://jan.ai/api-reference">API Reference</a>
<a href="https://cortex.so/docs/">Documentation</a> - <a href="https://cortex.so/api-reference">API Reference</a>
- <a href="https://github.com/janhq/cortex/releases">Changelog</a> - <a href="https://github.com/janhq/cortex/issues">Bug reports</a> - <a href="https://discord.gg/AsJ8krTT3N">Discord</a>
</p>

@@ -120,6 +120,8 @@ Here are example of models that you can use based on each supported engine:
> You should have at least 8 GB of RAM available to run the 7B models, 16 GB to run the 14B models, and 32 GB to run the 32B models.

## Cortex CLI Commands
> **Note**:
> For a more detailed CLI Reference documentation, please see [here](https://cortex.so/docs/cli).
### Start Cortex Server
```bash
cortex
@@ -130,10 +132,6 @@ cortex chat [options] [model_id] [message]
```
### Embeddings
```bash
# With a model started
cortex models start [model_id]
cortex embeddings [options] [message]
# Without any started models
cortex embeddings [options] [model_id] [message]
```
### Pull a Model
@@ -143,11 +141,7 @@ cortex pull <model_id>
> This command can also pulls Hugging Face's models.
### Download and Start a Model
```bash
cortex run [options] [model_id]
# With a specified engine
cortex run [options] [model_id]:[engine]
# Start chatting once the model started
cortex run [options] [model_id]:[engine] -c
```
### Get a Model Details
```bash
@@ -163,14 +157,7 @@ cortex models remove <model_id>
```
### Start a Model
```bash
# Start a model
cortex models start [model_id]

# Start a model with a preset
cortex models start [model_id] [options]

# Start with a specified engine
cortex models start [model_id]:[engine] [options]
```
### Stop a Model
```bash