You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.
I would like to make a quick modification to the structure
## Overview
- Combine "About" and "Installation"
## Quickstart
## Built-in Model Library
## Alternate Installation Methods
### Beta & Nightly
### Build from Source
About Section
Let's combine the "About" and "Installation" sections
We should include links only for the Stable release
We prefer "Download" link (vs. "cortexcpp.exe" filename)
You will need to ask @hiento09 for the exact Installers we are providing:
Mac might be universal
There might be a Network installer (i.e. pulls at install-time)
Quickstart
I would like to have a more comprehensive Quickstart, that covers our most common scenario:
# Start server
cortex start
# Pulls models
cortex pull <huggingface>
cortex pull llama3.1 # From our curated built-in model library
# Run and use model
cortex run llama3.1
cortex chat llama3.1
Guide the user to use the API server
Cortex server is running at localhost:3928
make API request to cortex.cpp
Guide user that they can use this with many integrations
curl /chat/completions
Walk the user to stop the model, and the server
cortex stop model
cortex stop
Possible additional things to weave in (we can discuss in comments):
.cortexrc
Model folder (after pull, see where files are stored)
Editing a model.yaml
Built-in Model Library
I would like to combine all 3 tables into one, simplified version
@dan-homebrew I think for the following we should just detail them in the docs rather than the readme, as I think this requires a lot of explanation as the readme should just be a simple docs that really introduces what is Cortex.cpp:
Goal
README Feedback
Structure
I would like to make a quick modification to the structure
About Section
You will need to ask @hiento09 for the exact Installers we are providing:
Quickstart
I would like to have a more comprehensive Quickstart, that covers our most common scenario:
Guide the user to use the API server
Walk the user to stop the model, and the server
Possible additional things to weave in (we can discuss in comments):
Built-in Model Library
I would like to combine all 3 tables into one, simplified version
:gguf
:tensorrt
:onnx
CLI Commands
REST API
Uninstall
Alternate Installation
The text was updated successfully, but these errors were encountered: