Skip to content

Commit

Permalink
Merge pull request #1209 from milvus-io/christy-demo
Browse files Browse the repository at this point in the history
Add image zilliz clusters, cleanup readme
  • Loading branch information
christy authored Nov 30, 2023
2 parents e6c47e5 + 9d94c8c commit 89bb3e2
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 12 deletions.
11 changes: 6 additions & 5 deletions bootcamp/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
### 📖 Tutorial Notebooks

| Notebook | Description | Video
|:-----------|:---------------------------|:------------|
| [Connect to Milvus/Zilliz](milvus_connect.ipynb)| Connect to Milvus running locally (lite, docker, k8s) or in a cloud (Zilliz). <br> Zilliz flavors include free tier (serverless) or paid (private cloud).| COMING SOON! |
| [Open source RAG with LangChain](RAG/readthedocs_zilliz_langchain.ipynb) | Build a question answering chatbot using your own product documentation for grounding LLMs (preventing hallucinations). This demo shows how to use all open-source LLMs (HuggingFace) for retrieval and chat with source citations. We also show how to use OpenAI ChatGPT for the last chat generation step. | COMING SOON! |
| [OpenAI Assistant with LlamaIndex](OpenAIAssistants/milvus_agent_llamaindex.ipynb) | This tutorial shows how to build an agent on top of the OpenAI Assistant API with a custom retriever tool. | COMING SOON! |
| Description | Notebook | Reading | Video
|:---------------------------|:----------|:----------|:----------|
| High-level introduction to Vectors, Embeddings, Vector search, Milvus vector database. | | [Vector Database 101](https://zilliz.com/learn/what-is-vector-database) |
| Connect to Milvus local server (lite, docker, k8s) or in a cloud (Zilliz). Zilliz flavors include free tier (serverless) or paid (managed aws, google, azure). | [Connect to Milvus/Zilliz](milvus_connect.ipynb) | [Getting Started with a Milvus Connection](https://zilliz.com/blog/getting-started-with-a-milvus-connection) | COMING SOON! |
| Build a question answering chatbot using your own product documentation for grounding LLMs (preventing hallucinations). Uses all open-source LLMs (HuggingFace) for retrieval and chat with source citations. Uses OpenAI ChatGPT for the last chat generation step. | [Open source RAG with LangChain](RAG/readthedocs_zilliz_langchain.ipynb) | [Build an Open Source Chatbot](https://zilliz.com/blog/building-open-source-chatbot-using-milvus-and-langchain-in-5-minutes)| COMING SOON! |
| Build an agent on top of the OpenAI Assistant API with a custom retriever tool. | [OpenAI Assistant with LlamaIndex](OpenAIAssistants/milvus_agent_llamaindex.ipynb) | [Limitations of OpenAI for custom RAG](https://zilliz.com/blog/customizing-openai-built-in-retrieval-using-milvus-vector-database)| COMING SOON! |
18 changes: 11 additions & 7 deletions bootcamp/milvus_connect.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"\n",
"💡 **For production purposes**, it is recommended to use Milvus local docker, clusters, or fully-managed Milvus on Zilliz Cloud. <br>\n",
"\n",
"2. [Milvus local](https://milvus.io/docs/install_standalone-docker.md) requires local docker installed and running.\n",
"2. [Milvus local docker](https://milvus.io/docs/install_standalone-docker.md) requires local docker installed and running.\n",
"3. [Ziliz Cloud free tier](#zilliz_free)\n",
"4. <a href=\"https://milvus.io/docs/install_cluster-milvusoperator.md\">Milvus clusters</a> requires a K8s cluster up and running.\n",
"5. <a href=\"https://api.python.langchain.com/en/latest/vectorstores/langchain.vectorstores.milvus.Milvus.html\">LangChain Milvus</a> and other 3rd party adapters.\n",
Expand Down Expand Up @@ -456,15 +456,19 @@
"\n",
"If you already have a Zilliz account and want to use free tier, just be sure to select \"Starter\" option when you [create your cluster](https://docs.zilliz.com/docs/create-cluster). ❤️‍🔥 **In other words, everybody gets free tier!!** \n",
"- One free tier cluster per account.\n",
"- Per free tier cluster, up to two collections (or vectordb indexes, you can think of these like \"tables\" of vectors) at a time.\n",
"- Each free tier collection can support up to 1M vectors.\n",
"- Per free tier cluster, up to two collections at a time. (Think of a collection like a database table. Each collection has an index, schema, and consistency-level).\n",
"- Each free tier collection can support up to 1M vectors (Think of this like rows in a database table).\n",
"\n",
"If you require additional clusters, we recommend subscribing to either our Standard or Enterprise plan.\n",
"\n",
"### 👩 Set up instructions for Zilliz \n",
"\n",
"1. From [cloud.zilliz.com](cloud.zilliz.com), click **\"+ Create Cluster\"**\n",
"2. Select <i>**Starter**</i> option for the cluster and click **\"Next: Create Collection\"**\n",
" <div>\n",
"<img src=\"../images/zilliz_cluster_choose.png\" width=\"60%\"/>\n",
"</div>\n",
"\n",
"3. Name your collection with a <i>**Collection Name**</i> and click **\"Create Collection and Cluster\"**.\n",
"4. From the Clusters page, \n",
" - copy the cluster uri and save somewhere locally.\n",
Expand All @@ -473,10 +477,10 @@
"<img src=\"../images/zilliz_cluster_uri_token.png\" width=\"80%\"/>\n",
"</div>\n",
"\n",
"5. Add the API KEY to your environment variables. See this [article for instructions](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety) how in either Windows or Mac/Linux environment.\n",
"6. In Jupyter, need .env file (in same dir as notebooks) containing lines like this:\n",
" - VARIABLE_NAME=value\n",
"7. In your code, connect to your Zilliz cluster, see code example below."
"1. Add the API KEY to your environment variables. See this [article for instructions](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety) how in either Windows or Mac/Linux environment.\n",
"2. In Jupyter, you'll also need .env file (in same dir as notebooks) containing lines like this:\n",
" - ZILLIZ_API_KEY=value\n",
"3. In your code, connect to your Zilliz cluster, see code example below."
]
},
{
Expand Down
Binary file added images/zilliz_cluster_choose.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 89bb3e2

Please sign in to comment.