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

Commit a322bac

Browse files
committed
remove /models-sources slug
1 parent fd6333f commit a322bac

File tree

6 files changed

+72
-147
lines changed

6 files changed

+72
-147
lines changed

docs/docs/hub/cortex-hub.mdx renamed to docs/docs/capabilities/models/sources/cortex-hub.mdx

File renamed without changes.
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Hugging Face
3+
description: Cortex supports all `GGUF` and `ONNX` models available in Huggingface repositories, providing access to a wide range of models.
4+
---
5+
6+
import Tabs from "@theme/Tabs";
7+
import TabItem from "@theme/TabItem";
8+
9+
Cortex.cpp supports all `GGUF` from the [Hugging Face Hub](https://huggingface.co).
10+
11+
You can pull HuggingFace models via:
12+
- repository handle: eg `author/model_id`
13+
- direct url: eg `https://huggingface.co/QuantFactory/OpenMath2-Llama3.1-8B-GGUF/blob/main/OpenMath2-Llama3.1-8B.Q4_0.gguf`
14+
15+
16+
## GGUF
17+
To view all available `GGUF` models on HuggingFace, select the `GGUF` tag in the Libraries section.
18+
19+
![HF GGUF](/img/docs/gguf.png)
20+
<Tabs>
21+
<TabItem value="MacOs/Linux" label="MacOs/Linux">
22+
```sh
23+
## Pull the Codestral-22B-v0.1-GGUF model from the bartowski organization
24+
cortex pull bartowski/Codestral-22B-v0.1-GGUF
25+
26+
# Pull the gemma-7b model from the google organization
27+
cortex pull https://huggingface.co/QuantFactory/OpenMath2-Llama3.1-8B-GGUF/blob/main/OpenMath2-Llama3.1-8B.Q4_0.gguf
28+
```
29+
</TabItem>
30+
<TabItem value="Windows" label="Windows">
31+
```sh
32+
## Pull the Codestral-22B-v0.1-GGUF model from the bartowski organization
33+
cortex.exe pull bartowski/Codestral-22B-v0.1-GGUF
34+
35+
# Pull the gemma-7b model from the google organization
36+
cortex.exe pull google/gemma-7b
37+
```
38+
</TabItem>
39+
</Tabs>
40+
41+
<!-- ## ONNX
42+
![HF ONNX](/img/docs/onnx.png)
43+
To view all available `ONNX` models on HuggingFace, select the `ONNX` tag in the Libraries section.
44+
<Tabs>
45+
<TabItem value="MacOs/Linux" label="MacOs/Linux">
46+
```sh
47+
## Pull the XLM-Roberta-Large-Vit-B-16Plus model from the immich-app organization
48+
cortex pull immich-app/XLM-Roberta-Large-Vit-B-16Plus
49+
50+
# Pull the mt0-base model from the bigscience organization
51+
cortex pull bigscience/mt0-base
52+
```
53+
</TabItem>
54+
<TabItem value="Windows" label="Windows">
55+
```sh
56+
## Pull the XLM-Roberta-Large-Vit-B-16Plus model from the immich-app organization
57+
cortex.exe pull immich-app/XLM-Roberta-Large-Vit-B-16Plus
58+
59+
# Pull the mt0-base model from the bigscience organization
60+
cortex.exe pull bigscience/mt0-base
61+
```
62+
</TabItem>
63+
</Tabs>
64+
65+
## TensorRT-LLM
66+
We are still working to support all available `TensorRT-LLM` models on HuggingFace. For now, Cortex.cpp only supports built-in `TensorRT-LLM` models, which can be downloaded from the [Cortex Model Repos](/docs/hub/cortex-hub). -->

docs/docs/hub/index.mdx renamed to docs/docs/capabilities/models/sources/index.mdx

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
---
2-
slug: /model-sources
32
title: Model Sources
3+
description: Model
44
---
55

6-
import DocCardList from "@theme/DocCardList";
7-
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-
126
# Pulling Models in Cortex
137

148
Cortex provides a streamlined way to pull (download) machine learning models from Hugging Face and other third-party sources, as well as import models from local storage. This functionality allows users to easily access a variety of pre-trained models to enhance their applications.
@@ -348,6 +342,4 @@ Response:
348342
}
349343
```
350344

351-
With Cortex, pulling and managing models is simplified, allowing you to focus more on building your applications!
352-
353-
<DocCardList />
345+
With Cortex, pulling and managing models is simplified, allowing you to focus more on building your applications!

docs/docs/hub/nvidia-ngc.mdx renamed to docs/docs/capabilities/models/sources/nvidia-ngc.mdx

File renamed without changes.

docs/docs/hub/hugging-face.mdx

Lines changed: 0 additions & 129 deletions
This file was deleted.

docs/sidebars.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,16 +88,12 @@ const sidebars: SidebarsConfig = {
8888
{
8989
type: "category",
9090
label: "Pulling Models",
91-
link: { type: "doc", id: "hub/index" },
91+
link: { type: "doc", id: "capabilities/models/sources/index" },
9292
collapsed: true,
9393
items: [
94-
{ type: "doc", id: "hub/hugging-face", label: "Adding a HF Organization" },
95-
// { type: "doc", id: "hub/cortex-hub", label: "Cortex Model Repos" },
96-
// {
97-
// type: "doc",
98-
// id: "hub/nvidia-ngc",
99-
// label: "Nvidia Catalog (Coming Soon)",
100-
// },
94+
// { type: "doc", id: "capabilities/models/sources/hugging-face", label: "Hugging Face" },
95+
// { type: "doc", id: "capabilities/models/sources/cortex-hub", label: "Cortex Model Repos" },
96+
// { type: "doc", id: "capabilities/models/sources/nvidia-ngc", label: "Nvidia Catalog (Coming Soon)"},
10197
],
10298
},
10399
{

0 commit comments

Comments
 (0)