You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ R2R (RAG to Riches) is a Python framework designed for the rapid construction an
5
5
6
6
### Quick Install:
7
7
8
-
1.**Install R2R directly using `pip`:**
8
+
**Install R2R directly using `pip`:**
9
9
10
10
```bash
11
11
pip install r2r
@@ -27,7 +27,8 @@ Follow these steps to ensure a smooth setup:
27
27
```
28
28
- Install the project dependencies with Poetry:
29
29
```bash
30
-
# See pyproject for available extras, use "all" for every optional dep.
30
+
# See pyproject.toml for available extras
31
+
# use "all" to include every optional dependency
31
32
poetry install --extras "parsing"
32
33
```
33
34
@@ -50,14 +51,14 @@ The project includes several basic examples that demonstrate application deploym
50
51
poetry run uvicorn examples.basic.app:app
51
52
```
52
53
53
-
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.
54
+
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.
54
55
55
56
```bash
56
57
poetry run python -m examples.client.test_client
57
58
```
58
59
59
60
60
-
2. [`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): A more comprehensive example demonstrating more realistic pdf chat.
61
+
3. [`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): A more comprehensive example demonstrating upload and chat with a more realistic pdf.
61
62
```bash
62
63
# Ingest pdf
63
64
poetry run python -m examples.pdf_chat.run_demo ingest
@@ -66,6 +67,13 @@ The project includes several basic examples that demonstrate application deploym
66
67
poetry run python -m examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
67
68
```
68
69
70
+
4. [`web`](web/package.json): A web application which is meant to accompany the framework to provide visual intelligence.
0 commit comments