Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Commit 42a6474

Browse files
authored
Merge pull request #1913 from janhq/function-calling-improvement
Enhanced Function Calling Guide and the main README, removed warnings at different places where Cortex is stable already, and tweaked the images to showcase current functionality without `tensorrt-llm`.
2 parents 596eb94 + 125a115 commit 42a6474

26 files changed

+276
-771
lines changed

README.md

Lines changed: 98 additions & 378 deletions
Large diffs are not rendered by default.

assets/cortex-banner.png

11.7 KB
Loading

docs/docs/architecture.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ slug: "architecture"
55
draft: true
66
---
77

8-
:::warning
9-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
10-
:::
11-
128
## Introduction
139

1410
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.

docs/docs/architecture/cortex-db.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "cortex-db"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

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

1511
![sqlite-view](/img/sqlite_view_harlequin.png)
1612
**db view via [Harlequin](https://harlequin.sh/)**

docs/docs/architecture/cortexrc.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "cortexrc"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

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

1511
Cortex supports using a config-based approach to configuring most of its functionality. During the
1612
installation process, a `.cortexrc` will be generated with some sensible defaults in it. Using this

docs/docs/architecture/data-folder.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "data-folder"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

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

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

docs/docs/architecture/updater.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "updater"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

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

1511
This document outlines the architectural design for a C++ updater responsible for downloading and executing
1612
the installers for the CLI and Server binaries.

docs/docs/chat-completions.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ description: Chat Completions Feature
66
import Tabs from "@theme/Tabs";
77
import TabItem from "@theme/TabItem";
88

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

1310
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.
1411

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

26-
```bash
27-
# Streaming
23+
```bash
24+
# Streaming
2825
cortex chat --model mistral
2926
```
3027
### API

docs/docs/configurations/cors.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ slug: "cors"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
12-
Cortex, which may not yet be fully implemented in the codebase.
13-
:::
14-
1510
This document describes how to configure Cross-Origin Resource Sharing (CORS) settings for the API server
1611
using the CLI commands and the HTTP API endpoints.
1712

docs/docs/configurations/proxy.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "proxy"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

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

1511
# Proxy Configuration Guide
1612

0 commit comments

Comments
 (0)