[Docs] Update developer documentation (#916)

This commit is contained in:
Deshraj Yadav
2023-11-07 19:07:47 -08:00
committed by GitHub
parent 3332e6e236
commit 98eb5b54be
3 changed files with 57 additions and 20 deletions

View File

@@ -3,6 +3,34 @@ title: ❓ FAQs
description: 'Collections of all the frequently asked questions' description: 'Collections of all the frequently asked questions'
--- ---
#### How to use `gpt-4-turbo` model released on OpenAI DevDay?
<CodeGroup>
```python main.py
import os
from embedchain import Pipeline as App
os.environ['OPENAI_API_KEY'] = 'xxx'
# load llm configuration from gpt4_turbo.yaml file
app = App.from_config(yaml_path="gpt4_turbo.yaml")
```
```yaml gpt4_turbo.yaml
llm:
provider: openai
config:
model: 'gpt-4-turbo'
temperature: 0.5
max_tokens: 1000
top_p: 1
stream: false
```
</CodeGroup>
#### How to use GPT-4 as the LLM model? #### How to use GPT-4 as the LLM model?
<CodeGroup> <CodeGroup>

View File

@@ -11,6 +11,10 @@ Install embedchain python package:
pip install embedchain pip install embedchain
``` ```
<Tip>
Embedchain now supports OpenAI's latest `gpt-4-turbo` model. Checkout the [docs here](/get-started/faq#how-to-use-gpt-4-turbo-model-released-on-openai-devday) on how to use it.
</Tip>
Creating an app involves 3 steps: Creating an app involves 3 steps:
<Steps> <Steps>

View File

@@ -3,38 +3,43 @@
"name": "Embedchain", "name": "Embedchain",
"logo": { "logo": {
"dark": "/logo/dark.svg", "dark": "/logo/dark.svg",
"light": "/logo/light.svg" "light": "/logo/light.svg",
"href": "https://embedchain.ai/"
}, },
"favicon": "/favicon.png", "favicon": "/favicon.png",
"colors": { "colors": {
"primary": "#2B48EE", "primary": "#3B2FC9",
"light": "#2B48EE", "light": "#6673FF",
"dark": "#2B48EE", "dark": "#3B2FC9",
"background": { "background": {
"dark": "#020415" "dark": "#0f1117",
"light": "#fff"
} }
}, },
"modeToggle": {
"default": "dark"
},
"openapi": ["/rest-api.json"], "openapi": ["/rest-api.json"],
"metadata": { "metadata": {
"og:image": "/images/og.png", "og:image": "/images/og.png",
"twitter:site": "@embedchain" "twitter:site": "@embedchain"
}, },
"topAnchor": { "anchors": [
"name": "Documentation", {
"icon": "book-open" "name": "Embedchain Platform",
}, "icon": "tv",
"url": "https://app.embedchain.ai/"
},
{
"name": "Join our slack",
"icon": "slack",
"url": "https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw"
}
],
"topbarLinks": [ "topbarLinks": [
{ {
"name": "Twitter", "name": "Create account",
"url": "https://twitter.com/embedchain" "url": "https://app.embedchain.ai/login/"
},
{
"name": "Slack",
"url": "https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw"
},
{
"name": "Discord",
"url": "https://discord.gg/6PzXDgEjG5"
} }
], ],
"topbarCtaButton": { "topbarCtaButton": {
@@ -106,7 +111,7 @@
] ]
}, },
{ {
"group": "Examples", "group": "Use Cases",
"pages": [ "pages": [
"examples/full_stack", "examples/full_stack",
"examples/discord_bot", "examples/discord_bot",