This repository has been archived by the owner on Nov 13, 2024. It is now read-only.
[WIP] Readme v0.1 canopy #86
Merged
Conversation
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
tests/unit/cli/test_basic.py
Outdated
There was a problem hiding this comment.
Remove from this branch
README.md
Outdated
Comment on lines
15
to
17
| * **ChatEngine** - is a complete RAG unit that exposes a chat interface of LLM augmented with retrieval engine. | ||
| * **ContextEngine** - is a proxy between your application and Pinecone. It will handle the R in the RAG pipeline and will return the snippet of context along with the respected source. | ||
| * **KnowledgeBase** - is the data managment interface, handles the processing, chunking and encoding (embedding) of the data, along with Upsert/Query and Delete operations |
There was a problem hiding this comment.
Remove and put a link to Amnon's sub-page
README.md
Outdated
|
|
||
| Where: | ||
| 3. **Resin CLI** - Resin comes with a fully functional CLI that is purposley built to allow users to quickly test their configuration and application before shipping, the CLI also comes with managment operations that allow you to create indexes and load data quickly |
There was a problem hiding this comment.
Suggested change
| 3. **Resin CLI** - Resin comes with a fully functional CLI that is purposley built to allow users to quickly test their configuration and application before shipping, the CLI also comes with managment operations that allow you to create indexes and load data quickly | |
| 3. **Resin CLI** - Fully functional development tool that allow users to quickly create a Resin service using their own documents, then test application before shipping to production. | |
| The CLI allows to create a new resin service with a single command, upload your own documents to it and test the application's responses using a built-in terminal based chat app. |
Comment on lines
+139
to
+140
| > The resin start command will keep the terminal occupied. To proceed with the next steps, please open a new terminal window. | ||
| > and make sure all the environment variables described in the [installation](#how-to-install) section are set. |
There was a problem hiding this comment.
Suggested change
| > The resin start command will keep the terminal occupied. To proceed with the next steps, please open a new terminal window. | |
| > and make sure all the environment variables described in the [installation](#how-to-install) section are set. | |
| > The resin start command will keep the terminal occupied, allowing for quickly stoping the service by hitting `Ctrl-C`. Alternatively, you can run the `resin stop` command from any window to shutdown the resin service, which would release the shell. | |
| If you'd like to try the terminal-based demo chat tool - please run `resin chat` in a new terminal window. |
igiloh-pinecone
suggested changes
Oct 24, 2023
There was a problem hiding this comment.
@miararoy please see two changes (not to the readme itself)
pyproject.toml
Outdated
| @@ -64,5 +65,5 @@ per-file-ignores = [ | |||
| max-line-length = 88 | |||
|
|
|||
| [tool.poetry.scripts] | |||
| resin = "resin_cli.cli:cli" | |||
| canopy = "resin_cli.cli:cli" | |||
There was a problem hiding this comment.
Remove from this branch
| @@ -23,6 +23,7 @@ uvicorn = "^0.20.0" | |||
| tenacity = "^8.2.1" | |||
| sse-starlette = "^1.6.5" | |||
| types-tqdm = "^4.61.0" | |||
| tqdm = "^4.66.1" | |||
There was a problem hiding this comment.
Wait - isn't tqdm already a dependency???
If it isn't - please push as a separate PR
| @@ -1,55 +1,110 @@ | |||
| # Resin | |||
|
|
|||
| **Resin** is a tool that allows you to build AI applications using your own data. It is built on top of Pinecone, the world's most powerfull vector database. **Resin** is desinged to be well packaged and easy to use. It can be used as a library or as a service. It is also designed to be modular, so you can use only the parts that you need. **Resin** is built with the following principles in mind: | |||
| **Resin** is a Sofware Development Kit (SDK) for AI applications. Resin allows you to test, build and package Retrieval Augmented Applications with Pinecone Vector Database. **Resin** is desinged to be well packaged and easy to use. It can be used as-a-library or as-a-service and designed to be modular, so you can use only the parts that you need. **Resin** ships with a developer friendly CLI, to help you kickoff and test your application quickly. | |||
There was a problem hiding this comment.
Suggested change
| **Resin** is a Sofware Development Kit (SDK) for AI applications. Resin allows you to test, build and package Retrieval Augmented Applications with Pinecone Vector Database. **Resin** is desinged to be well packaged and easy to use. It can be used as-a-library or as-a-service and designed to be modular, so you can use only the parts that you need. **Resin** ships with a developer friendly CLI, to help you kickoff and test your application quickly. | |
| **Resin** is a Sofware Development Kit (SDK) for AI applications. Resin allows you to test, build and package Retrieval Augmented Applications with Pinecone Vector Database. | |
| **Resin** is designed to be well packaged and easy to use. It can be used as-a-library or as-a-service and designed to be modular, so you can use only the parts that you need. | |
| **Resin** ships with a developer friendly CLI, to help you kickoff and test your application quickly. |
Using double spaces in md allows you to drop the paragraph to a new line, which looks better
| |----------+--------------+--------------+---------------| | ||
| | "1" | "some text" | "some source"| {"key": "val"}| | ||
| | "id1" | "some text" | "some source"| {"key": "val"}| |
There was a problem hiding this comment.
@miararoy you need to remove the ``` from this table. It prevents it from being rendered as an actual MD table
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Describe the purpose of this change. What problem is being solved and why?
Solution
Describe the approach you took. Link to any relevant bugs, issues, docs, or other resources.
Type of Change
Test Plan
Describe specific steps for validating this change.