Skip to content

Commit 6cb855f

Browse files
committed
completed ai models content + added images
1 parent 0da5da0 commit 6cb855f

File tree

7 files changed

+43
-26
lines changed

7 files changed

+43
-26
lines changed

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
1-
# Mintlify Starter Kit
2-
3-
Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
4-
5-
- Guide pages
6-
- Navigation
7-
- Customizations
8-
- API Reference pages
9-
- Use of popular components
1+
# Shinkai Docs
2+
This page is built using Mintlify.
103

114
### Development
125

essentials/custom-ai.mdx

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,9 @@ icon: 'robot'
55
---
66

77
<Tip>
8-
Sections:
9-
- ~Definition of model features (technical guide)~
10-
- ~Models comparison - table~
11-
- List of models + constantly updating -> Ollama
12-
- Installing manual AI
13-
- Custom AI installation
14-
8+
AI models in Shinkai are powered by Ollama and are constantly being updated.
159
</Tip>
1610

17-
> Models in Shinkai are pulled from Ollama....definition
1811

1912
## Understanding AI Models
2013
If you're looking to install an AI model but aren’t sure where to start, understanding the key features of each model can make your decision easier.
@@ -62,25 +55,54 @@ Whether you’re using it for casual text generation or advanced AI tasks, learn
6255
</ResponseField>
6356

6457
### AI Models Comparison
65-
58+
Choosing the right AI model depends on the task you want to perform and the specs of your device.
59+
Models may have different versions to install, here are a few examples:
6660
| **Model** | **Parameters** | **Quantization** | **Best For** |
6761
|--------------------|------------------------------------|------------------|---------------------------------------------|
6862
| **Llama3.1** | 8B, 70B, 405B | Q8, FP16 | Advanced tools, large-scale tasks |
6963
| **Gemma2** | 2B, 9B, 27B | Q8 | Efficient text generation and language tasks|
7064
| **Mistral-Nemo** | 12B, 70B | Q4 | Long-context tasks, multi-lingual support |
7165
| **Qwen2** | 0.5B, 1.5B, 7B, 72B | Q4, Q8 | Text processing, general AI tasks |
7266
| **Deepseek-Coder** | 16B, 236B | Q8, FP16 | Code generation, fill-in-the-middle tasks |
73-
| **Command-R** | 35B | Q8 | Conversational, long-context interactions |
74-
| **Mistral** | 7B | Q4 | Lightweight multi-lingual tasks |
7567
| **CodeGemma** | 2B, 7B | Q8 | Code generation, instruction-following tasks|
76-
| **Command-R+** | 104B | FP16 | Enterprise AI, large-scale conversational tasks|
77-
| **Mixtral** | 8x7B, 8x22B | Q4 | Mixture-of-Experts tasks, multi-lingual tasks|
7868

69+
### Browsing AI models in Shinkai
7970

71+
Shinkai offers you a wide array of models to choose from. To browse the whole list of AI models in Shinkai, click the `AIs` option of the left side menu > Click the `Show all models` option below the recommended models.
8072

8173
<Frame>
8274
<img src="/images/models-list.jpg" style={{ borderRadius: '0.5rem' }} />
8375
</Frame>
76+
In this view you can access the different models available in Shinkai. This list is continously being updated.
77+
78+
<Tip>
79+
You can choose the version of the model you'd like to install in the dropdown menu next to the model's name.
80+
81+
Refer to the **[parameters and quantization](/essentials/custom-ai#understanding-ai-models)** guidelines to help you make the best choice for your device and task.
82+
</Tip>
83+
84+
## Installing AIs Manually
85+
The list of AI models in Shinkai is powered by Ollama and is continously growing. Although, if you want to install another model, you can do it easily:
8486

85-
## Installing Custom AIs
87+
1. Click the `AIs` option on the left side menu > Click the `+ Manually Add AI` button on the upper-right corner.
88+
<Frame>
89+
<img src="/images/manual-ai.jpg" style={{ borderRadius: '0.5rem' }} />
90+
</Frame>
91+
2. Select the model you'd like to install. Currently, the available options are: *OpenAI, Together AI, Ollama, Gemini, and Exo*.
92+
3. Choose the model type or version you want to install.
93+
4. Customize the name of the model or leave the name given by default.
94+
5. Enter the URL of the model source.
95+
6. Enter the **API key** for the model *(e.g., you need an active subscription in OpenAI to request API keys of their models)*.
96+
7. Click 'Add AI'. You will now see the model available in the `AIs` view and within the model dropdown of AI Chats.
8697

98+
99+
<Frame>
100+
<img src="/images/manual-ai-b.jpg" style={{ borderRadius: '0.5rem' }} />
101+
</Frame>
102+
103+
### Custom AIs
104+
If the model you want to install is not present in the models list, you can add custom models providing the information requested in the form: *Model name (service provider); model type; model name to appear in the chats; external URL; and API key*.
105+
106+
<Frame>
107+
<img src="/images/custom-ai.jpg" style={{ borderRadius: '0.5rem' }} />
108+
</Frame>

essentials/settings.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ icon: 'gear'
77
<Tip>
88
In this section:
99
- General
10-
- Node Manager -> Connecting to the Node?
10+
- Node Manager -> Connecting to the Node
11+
- Creating Shinkai Identity
1112
- Export Connection
1213
- Registration Code
1314
- Public Keys

images/custom-ai.jpg

1.48 MB
Loading

images/manual-ai-b.jpg

1.62 MB
Loading

images/manual-ai.jpg

1.82 MB
Loading

quickstart.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,9 @@ The extension enables Shinkai to access, summarize, and organize web content dir
108108
Shinkai Visor acts as a smart assistant while you browse, providing real-time insights and automating tasks, all while keeping your data private and secure on your device.
109109

110110
### Connecting Shinkai Visor to your Desktop App
111-
Connecting Shinkai Visor to the Shinkai Desktop App provides a more powerful and integrated AI experience.
112-
111+
<Tip>
112+
Connecting Shinkai Visor to the Shinkai Desktop App provides a more powerful and integrated AI experience.
113+
</Tip>
113114
With this connection, your desktop app can pull data and insights directly from your web browsing activities, enabling seamless cross-platform AI assistance.
114115

115116
#### 1. Export your connection

0 commit comments

Comments
 (0)