Skip to content

Commit

Permalink
cleanup readme typos (#72)
Browse files Browse the repository at this point in the history
  • Loading branch information
emrgnt-cmplxty authored Feb 26, 2024
1 parent 8f7e897 commit f7f7b00
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ R2R (RAG to Riches) is a Python framework designed for the rapid construction an

### Quick Install:

1. **Install R2R directly using `pip`:**
**Install R2R directly using `pip`:**

```bash
pip install r2r
Expand All @@ -27,7 +27,8 @@ Follow these steps to ensure a smooth setup:
```
- Install the project dependencies with Poetry:
```bash
# See pyproject for available extras, use "all" for every optional dep.
# See pyproject.toml for available extras
# use "all" to include every optional dependency
poetry install --extras "parsing"
```

Expand All @@ -50,14 +51,14 @@ The project includes several basic examples that demonstrate application deploym
poetry run uvicorn examples.basic.app:app
```

2. [`run_client.py`](examples/basic/run_client.py): This example should be run after starting the main application. It demonstrates a test of the user client. This includes uploading text entries as well as a PDF.
2. [`run_client.py`](examples/basic/run_client.py): This example should be run after starting the main application. It demonstrates uploading text entries as well as a PDF with the python client. Further, it shows document and user-level management with built-in features.

```bash
poetry run python -m examples.client.test_client
```


2. [`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): A more comprehensive example demonstrating more realistic pdf chat.
3. [`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): A more comprehensive example demonstrating upload and chat with a more realistic pdf.
```bash
# Ingest pdf
poetry run python -m examples.pdf_chat.run_demo ingest
Expand All @@ -66,6 +67,13 @@ The project includes several basic examples that demonstrate application deploym
poetry run python -m examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
```

4. [`web`](web/package.json): A web application which is meant to accompany the framework to provide visual intelligence.
```bash
cd web && pnpm install
# Serve the web app
pnpm dev
```


## Demonstration

Expand Down

0 comments on commit f7f7b00

Please sign in to comment.