Skip to content

Commit

Permalink
Update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
gorarakelyan committed Sep 27, 2023
1 parent 97d8fb4 commit 56e2fcf
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ This repository contains 3 demos showcasing the capabilities and features of Aim

3. **LlamaIndex Retriever**:
- A query engine tailored to answer questions over your data.
- Logs hparams, metrics, images, figures.

For detailed instructions on how to set up and use each demo app, please refer to the individual readme files within their respective directories.

## Prerequisites

- Ensure you have the latest version of Aim installed.
- Obtain and instrument an OpenAI API key.
- Install the corresponding Aim app for logging and observability.
- Obtain and instrument an OpenAI API key.
1 change: 0 additions & 1 deletion langchain-chatbot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

**Prerequisites:**
- Make sure Aim latest version is installed.
- Make sure `langchain-debugger` Aim app is installed (github.com/aimhubio/langchain-debugger).

## Screenshots

Expand Down
1 change: 0 additions & 1 deletion llamaindex-retriever/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ You can build your own index by following the instructions menioned below.

**Prerequisites:**
- Make sure Aim latest version is installed.
- Make sure llamaindex-observer app is installed (https://github.com/aimhubio/llamaindex-observer).
5 changes: 2 additions & 3 deletions mnist-training/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ Aim is instrumented to track model performance metrics, images and plotly figure
## Get Started

This app already includes logs of several trainings, so you can just run Aim UI:
- `aim ui --package asp`
- `aim ui`

Otherwise, run your own trainings:
1. Install requirements `pip install -r requirements.txt`
2. Make sure the latest version of Aim is installed
3. Run `python train.py`
2. Run `python train.py`

0 comments on commit 56e2fcf

Please sign in to comment.