Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
logan-markewich committed Nov 22, 2023
1 parent 0247a10 commit fdb7b37
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 3 deletions.
12 changes: 11 additions & 1 deletion llama_hub/llama_packs/retry_engine_weaviate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@
This LlamaPack inserts your data into [Weaviate](https://weaviate.io/developers/weaviate) and uses the [Retry Query Engine](https://gpt-index.readthedocs.io/en/latest/examples/evaluation/RetryQuery.html) for your RAG application.


## Usage
## CLI Usage

You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:

```bash
llamaindex-cli download-llamapack WeaviateRetryQueryEnginePack --download-dir ./weaviate_pack
```

You can then inspect the files at `./weaviate_pack` and use them as a template for your own project.

## Code Usage

You can download the pack to a the `./weaviate_pack` directory:

Expand Down
12 changes: 11 additions & 1 deletion llama_hub/llama_packs/sub_question_weaviate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@
This LlamaPack inserts your data into [Weaviate](https://weaviate.io/developers/weaviate) and uses the [Sub-Question Query Engine](https://gpt-index.readthedocs.io/en/latest/examples/query_engine/sub_question_query_engine.html) for your RAG application.


## Usage
## CLI Usage

You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:

```bash
llamaindex-cli download-llamapack WeaviateSubQuestion --download-dir ./weaviate_pack
```

You can then inspect the files at `./weaviate_pack` and use them as a template for your own project.

## Code Usage

You can download the pack to a the `./weaviate_pack` directory:

Expand Down
12 changes: 11 additions & 1 deletion llama_hub/llama_packs/timescale_vector_autoretrieval/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,17 @@ Timescale Vector is cloud PostgreSQL for AI that scales with you from POC to pro
### How to access Timescale Vector
Llama index users get a 90-day free trial for Timescale Vector. [Sign up here](https://console.cloud.timescale.com/signup?utm_campaign=vectorlaunch&utm_source=llamaindex&utm_medium=referral) for a free cloud vector database.

## Usage
## CLI Usage

You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:

```bash
llamaindex-cli download-llamapack TimescaleVectorAutoretrievalPack --download-dir ./tsv_pack
```

You can then inspect the files at `./tsv_pack` and use them as a template for your own project.

## Code Usage

You can download the pack to a the `./tsv_pack` directory:

Expand Down

0 comments on commit fdb7b37

Please sign in to comment.