This repository has been archived by the owner on Sep 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add quikcstart collab notebook (#48)
* add setuptools classifiers * add open in collab buton * update pre-commit codespell to skip .ipynb * add quickstart collab notebook * update notebook * add required extensions option to document readers (#50) * add required exts option to document readers * update autollm version * update version to 0.0.12 (#52) * add setuptools classifiers * add open in collab buton * update pre-commit codespell to skip .ipynb * add quickstart collab notebook * update notebook * update readme * update * add example notebook
- Loading branch information
1 parent
009f08f
commit aaa70f4
Showing
4 changed files
with
308 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,291 @@ | ||
| { | ||
| "cells": [ | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "[](https://colab.research.google.com/github/safevideo/autollm/blob/main/examples/quickstart.ipynb)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## 0. Preparation" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "- Install latest version of autollm:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": { | ||
| "vscode": { | ||
| "languageId": "shellscript" | ||
| } | ||
| }, | ||
| "outputs": [], | ||
| "source": [ | ||
| "!pip install autollm -Uq\n", | ||
| "!pip install gradio -Uq\n", | ||
| "!pip install gitpython -Uq\n", | ||
| "!pip install nbconvert -Uq" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "- Import required modules:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "# import required functions, classes\n", | ||
| "from autollm import AutoQueryEngine\n", | ||
| "from autollm.utils.document_reading import read_github_repo_as_documents\n", | ||
| "import os\n", | ||
| "import gradio as gr" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "- Set your OpenAI API key in order to use default gpt-3.5-turbo model:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "os.environ[\"OPENAI_API_KEY\"] = \"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\"" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "os.environ[\"OPENAI_API_KEY\"] = \"YOUR_API_KEY\"" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## 1. Read Files as Documents" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "- Either set input directory or input files:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "git_repo_url = \"https://github.com/langchain-ai/langchain.git\"\n", | ||
| "relative_folder_path = \"docs\" # relative path from the repo root to the folder containing documents\n", | ||
| "required_exts = [\".md\", \".ipynb\"] # only files with these extensions will be read\n", | ||
| "\n", | ||
| "documents = read_github_repo_as_documents(git_repo_url=git_repo_url, relative_folder_path=\"docs\", required_exts=required_exts)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## 2. Configuration of AutoQueryEngine" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Basic Usage" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "- You can completely skip configuration if you want to use default settings." | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "- 🌟 **pro tip**: autollm defaults to lancedb as the vector store since it is lightweight, scales from development to production and is 100x cheaper than alternatives!" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "query_engine = AutoQueryEngine.from_parameters(documents=documents)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Advanced Usage" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "- You can configure the AutoQueryEngine to your needs:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "system_prompt = \"You are an friendly ai assistant that help users find the most relevant and accurate answers to their questions based on the documents you have access to. When answering the questions, mostly rely on the info in documents.\"\n", | ||
| "\n", | ||
| "query_wrapper_prompt = '''\n", | ||
| "The document information is below.\n", | ||
| "---------------------\n", | ||
| "{context_str}\n", | ||
| "---------------------\n", | ||
| "Using the document information and mostly relying on it,\n", | ||
| "answer the query.\n", | ||
| "Query: {query_str}\n", | ||
| "Answer:\n", | ||
| "'''\n", | ||
| "\n", | ||
| "enable_cost_calculator = True\n", | ||
| "\n", | ||
| "# llm params\n", | ||
| "model = \"gpt-3.5-turbo\"\n", | ||
| "\n", | ||
| "# vector store params\n", | ||
| "vector_store_type = \"LanceDBVectorStore\"\n", | ||
| "# specific params for LanceDBVectorStore\n", | ||
| "uri = \"tmp/lancedb\" \n", | ||
| "table_name = \"vectors\"\n", | ||
| "\n", | ||
| "# service context params\n", | ||
| "chunk_size = 1024\n", | ||
| "\n", | ||
| "# query engine params\n", | ||
| "similarity_top_k = 5" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "llm_params = {\"model\": model}\n", | ||
| "vector_store_params = {\"vector_store_type\": vector_store_type, \"uri\": uri, \"table_name\": table_name}\n", | ||
| "service_context_params = {\"chunk_size\": chunk_size}\n", | ||
| "query_engine_params = {\"similarity_top_k\": similarity_top_k}\n", | ||
| "\n", | ||
| "query_engine = AutoQueryEngine.from_parameters(documents=documents, system_prompt=system_prompt, query_wrapper_prompt=query_wrapper_prompt, enable_cost_calculator=enable_cost_calculator, llm_params=llm_params, vector_store_params=vector_store_params, service_context_params=service_context_params, query_engine_params=query_engine_params)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## 3. Ask Anything to Your Documents" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "response = query_engine.query(\"who are you\")" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "response.response" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "- Or play with it in the gradio app 🚀" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "import gradio as gr\n", | ||
| "\n", | ||
| "def greet(query):\n", | ||
| " return query_engine.query(query).response\n", | ||
| "\n", | ||
| "demo = gr.Interface(fn=greet, inputs=\"text\", outputs=\"text\")\n", | ||
| " \n", | ||
| "demo.launch()" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### If you found this project useful, [give it a ⭐️ on GitHub](https://github.com/safevideo/autollm) to show your support!" | ||
| ] | ||
| } | ||
| ], | ||
| "metadata": { | ||
| "kernelspec": { | ||
| "display_name": "aidocs", | ||
| "language": "python", | ||
| "name": "python3" | ||
| }, | ||
| "language_info": { | ||
| "codemirror_mode": { | ||
| "name": "ipython", | ||
| "version": 3 | ||
| }, | ||
| "file_extension": ".py", | ||
| "mimetype": "text/x-python", | ||
| "name": "python", | ||
| "nbconvert_exporter": "python", | ||
| "pygments_lexer": "ipython3", | ||
| "version": "3.10.12" | ||
| } | ||
| }, | ||
| "nbformat": 4, | ||
| "nbformat_minor": 2 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters