Update readme #132
Merged
Update readme #132
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
Owner
jerpint
commented
Sep 21, 2023
jerpint
commented
- Ship data with example app
- Update readme with better instructions
- add CLI args for some tool utilites
hbertrand
approved these changes
Sep 21, 2023
README.md
Outdated
|
|
||
| We've attached a sample `stackoverflow.csv` file to help you get started. | ||
| Once your local version of Buster is up and running, the next step is for you to be able to import your own data. | ||
| We will be using the `stackoverflow.csv` file in the `buster/examples/` folder for this. This is the same data that was used to generate the demo app's embeddings. | ||
|
|
||
| You will first ingest the documents to be ready for buster. In this example, we use Deeplake's vectore store, but you can always write your own custom `DocumentManager`: |
There was a problem hiding this comment.
typo: vectore -> vector
README.md
Outdated
| pip install buster-doctalk | ||
| ``` | ||
|
|
||
| If you would like to install a local version, run this instead: | ||
| Then, go to the examples folder and launch the app. | ||
| We've included small sample data on stackoverflow-ai questions that you can test your setup with to try app: |
There was a problem hiding this comment.
typo: small sample data on stackoverflow-ai questions -> small sample data off stackoverflow-ai questions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.