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

Enhanced Function Calling Guide & Main README, removed warning #1913

Merged
merged 6 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
476 changes: 98 additions & 378 deletions README.md

Large diffs are not rendered by default.

Binary file modified assets/cortex-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 0 additions & 4 deletions docs/docs/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ slug: "architecture"
draft: true
---

:::warning
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
:::

## Introduction

Cortex is a C++ AI engine designed to operate entirely on your local hardware infrastructure. This headless backend platform is also engineered to support TensorRT-LLM, ensuring high-performance machine-learning model execution. It is packaged with a Docker-inspired command-line interface and a Typescript client library.
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/architecture/cortex-db.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ slug: "cortex-db"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior
of Cortex, which may not yet be fully implemented in the codebase.
:::

![sqlite-view](/img/sqlite_view_harlequin.png)
**db view via [Harlequin](https://harlequin.sh/)**
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/architecture/cortexrc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ slug: "cortexrc"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
Cortex, which may not be fully implemented in the codebase yet.
:::

Cortex supports using a config-based approach to configuring most of its functionality. During the
installation process, a `.cortexrc` will be generated with some sensible defaults in it. Using this
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/architecture/data-folder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ slug: "data-folder"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under active development. Our documentation outlines the
intended behavior of Cortex and some functionality may not be fully implemented yet.
:::

When you install Cortex.cpp, three types of files will be generated on your device:

Expand Down
4 changes: 0 additions & 4 deletions docs/docs/architecture/updater.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ slug: "updater"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
Cortex, which may not yet be fully implemented in the codebase.
:::

This document outlines the architectural design for a C++ updater responsible for downloading and executing
the installers for the CLI and Server binaries.
Expand Down
7 changes: 2 additions & 5 deletions docs/docs/chat-completions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ description: Chat Completions Feature
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
:::

Cortex's Chat API is compatible with OpenAI’s [Chat Completions](https://platform.openai.com/docs/api-reference/chat) endpoint. It is a drop-in replacement for local inference.

Expand All @@ -23,8 +20,8 @@ Cortex routes requests to multiple APIs for remote inference while providing a s
## Usage
### CLI

```bash
# Streaming
```bash
# Streaming
cortex chat --model mistral
```
### API
Expand Down
5 changes: 0 additions & 5 deletions docs/docs/configurations/cors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ slug: "cors"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
Cortex, which may not yet be fully implemented in the codebase.
:::

This document describes how to configure Cross-Origin Resource Sharing (CORS) settings for the API server
using the CLI commands and the HTTP API endpoints.

Expand Down
4 changes: 0 additions & 4 deletions docs/docs/configurations/proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ slug: "proxy"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended
behavior of Cortex, which may not yet be fully implemented in the codebase.
:::

# Proxy Configuration Guide

Expand Down
4 changes: 0 additions & 4 deletions docs/docs/configurations/token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ slug: "token"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
Cortex, which may not yet be fully implemented in the codebase.
:::

A lot of the models available today can be found on HuggingFace. This page describes how to configure
HuggingFace token settings for Cortex.
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/cortex-cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ description: Cortex.cpp Architecture
slug: "cortex-cpp"
---

:::warning
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
:::

Cortex.cpp is a Local AI engine that is used to run and customize LLMs. Cortex can be deployed as a standalone server, or integrated into apps like [Jan.ai](https://jan.ai/)

Cortex's roadmap is to eventually support full OpenAI API-equivalence.
Expand Down
7 changes: 2 additions & 5 deletions docs/docs/cortex-llamacpp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ slug: "cortex-llamacpp"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
:::

:::info
`llamacpp` is formerly called "Nitro".
Expand Down Expand Up @@ -67,9 +64,9 @@ The command will check, download, and install these dependencies:
- Cuda 12.2:
- libcublas.so.12
- libcublasLt.so.12
- libcudart.so.12
- libcudart.so.12
- Cuda 12.4:
- libcublasLt.so.12
- libcublasLt.so.12
- libcublas.so.12
```
</TabItem>
Expand Down
9 changes: 3 additions & 6 deletions docs/docs/embeddings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,15 @@ slug: "embeddings"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
:::

An embedding is a vector that represents a piece of text, with the distance between vectors indicating similarity, which means closer distances mean more similar texts, while farther distances mean less similar texts.

:::note
The Cortex Embeddings feature is fully compatible with OpenAI's [Embeddings API](https://platform.openai.com/docs/api-reference/embeddings) endpoints.
:::

## Usage
### CLI
```bash
```bash
# Without Flag
cortex embeddings "Hello World"
# With model_id Flag
Expand Down Expand Up @@ -84,4 +81,4 @@ For a complete list of models, please visit the [Cortex Hub](https://huggingface
Learn more about Embeddings capabilities:
- [Embeddings API Reference](/api-reference#tag/embeddings/post/embeddings)
- [Embeddings CLI command](/docs/cli/embeddings)
:::
:::
Loading
Loading