Skip to content

Commit 7380d0d

Browse files
Feature/ship config (#88)
* ship with config * increment
1 parent 9956ac0 commit 7380d0d

File tree

5 files changed

+12
-6
lines changed

5 files changed

+12
-6
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,28 +35,28 @@ The project includes several basic examples that demonstrate application deploym
3535
1. [`app.py`](examples/basic/app.py): This example runs the main application, which includes the ingestion, embedding, and RAG pipelines served via FastAPI.
3636

3737
```bash
38-
poetry run uvicorn r2r.examples.basic.app:app
38+
uvicorn r2r.examples.basic.app:app
3939
```
4040

4141
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 to the local server with the python client. Further, it shows document and user-level vector management with built-in features.
4242

4343
```bash
44-
poetry run python -m r2r.examples.basic.run_client
44+
python -m r2r.examples.basic.run_client
4545
```
4646

4747
3. [`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): An example demonstrating upload and chat with a more realistic pdf.
4848

4949
```bash
5050
# Ingest pdf
51-
poetry run python -m r2r.examples.pdf_chat.run_demo ingest
51+
python -m r2r.examples.pdf_chat.run_demo ingest
5252

5353
# Ask a question
54-
poetry run python -m r2r.examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
54+
python -m r2r.examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
5555
```
5656

5757
4. [`web`](web/package.json): A web application which is meant to accompany the framework to provide visual intelligence.
5858
```bash
59-
cd web && pnpm install
59+
cd $workdir/web && pnpm install
6060
# Serve the web app
6161
pnpm dev
6262
```
@@ -90,6 +90,11 @@ Follow these steps to ensure a smooth setup:
9090
# use "all" to include every optional dependency
9191
poetry install --extras "parsing"
9292
```
93+
- Execute with poetry run:
94+
```bash
95+
poetry run python -m r2r.examples.pdf_chat.run_demo ingest
96+
```
97+
9398

9499
3. **Configure Environment Variables:**
95100
- You need to set up cloud provider secrets in your `.env`. At a minimum, you will need an OpenAI key.

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ build-backend = "poetry.core.masonry.api"
44

55
[tool.poetry]
66
name = "r2r"
7-
version = "0.1.2"
7+
version = "0.1.21"
88
description = "SciPhi R2R"
99
authors = ["Owen Colegrove <[email protected]>"]
1010
license = "MIT"
1111
readme = "README.md"
12+
include = ["config.json"]
1213

1314
[tool.poetry.dependencies]
1415
# Python Versions

r2r/examples/academy/__init__.py

Whitespace-only changes.

r2r/examples/pdf_chat/__init__.py

Whitespace-only changes.

r2r/examples/web_search/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)