소스 검색

[Docs] Update developer documentation (#916)

Deshraj Yadav 1 년 전
부모
커밋
98eb5b54be
3개의 변경된 파일54개의 추가작업 그리고 17개의 파일을 삭제
  1. 28 0
      docs/get-started/faq.mdx
  2. 4 0
      docs/get-started/quickstart.mdx
  3. 22 17
      docs/mint.json

+ 28 - 0
docs/get-started/faq.mdx

@@ -3,6 +3,34 @@ title: ❓ FAQs
 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?
 
 <CodeGroup>

+ 4 - 0
docs/get-started/quickstart.mdx

@@ -11,6 +11,10 @@ Install embedchain python package:
 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:
 
 <Steps>

+ 22 - 17
docs/mint.json

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