From 6acccd2b042833030cb2eca44f70990bcf9b1d6b Mon Sep 17 00:00:00 2001
From: Thuc Pham <51660321+thucpn@users.noreply.github.com>
Date: Tue, 9 Apr 2024 13:45:12 +0700
Subject: [PATCH] feat: use poetry run generate (#41)
Co-authored-by: Marcus Schiesser <mail@marcusschiesser.de>
---
.changeset/four-tools-buy.md | 5 +++++
README.md | 2 +-
helpers/index.ts | 4 ++--
helpers/typescript.ts | 2 +-
templates/components/engines/python/chat/__init__.py | 2 +-
templates/components/vectordbs/python/astra/generate.py | 2 +-
templates/components/vectordbs/python/milvus/generate.py | 2 +-
templates/components/vectordbs/python/mongo/generate.py | 2 +-
templates/components/vectordbs/python/none/generate.py | 2 +-
templates/components/vectordbs/python/pg/generate.py | 2 +-
templates/components/vectordbs/python/pinecone/generate.py | 2 +-
templates/types/streaming/fastapi/README-template.md | 4 ++--
templates/types/streaming/fastapi/pyproject.toml | 3 +++
13 files changed, 21 insertions(+), 13 deletions(-)
create mode 100644 .changeset/four-tools-buy.md
diff --git a/.changeset/four-tools-buy.md b/.changeset/four-tools-buy.md
new file mode 100644
index 00000000..ce132ccb
--- /dev/null
+++ b/.changeset/four-tools-buy.md
@@ -0,0 +1,5 @@
+---
+"create-llama": patch
+---
+
+Use poetry run generate to generate embeddings for FastAPI
diff --git a/README.md b/README.md
index 81a8eb88..e9228b3b 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Then re-start your app. Remember you'll need to re-run `generate` if you add new
If you're using the Python backend, you can trigger indexing of your data by calling:
```bash
-poetry run python app/engine/generate.py
+poetry run generate
```
## Want a front-end?
diff --git a/helpers/index.ts b/helpers/index.ts
index 8b2fead7..8c990fac 100644
--- a/helpers/index.ts
+++ b/helpers/index.ts
@@ -33,7 +33,7 @@ async function generateContextData(
if (packageManager) {
const runGenerate = `${cyan(
framework === "fastapi"
- ? "poetry run python app/engine/generate.py"
+ ? "poetry run generate"
: `${packageManager} run generate`,
)}`;
const openAiKeyConfigured = openAiKey || process.env["OPENAI_API_KEY"];
@@ -46,7 +46,7 @@ async function generateContextData(
if (framework === "fastapi") {
if (isHavingPoetryLockFile()) {
console.log(`Running ${runGenerate} to generate the context data.`);
- const result = tryPoetryRun("python app/engine/generate.py");
+ const result = tryPoetryRun("poetry run generate");
if (!result) {
console.log(`Failed to run ${runGenerate}.`);
process.exit(1);
diff --git a/helpers/typescript.ts b/helpers/typescript.ts
index db159a3f..e9553371 100644
--- a/helpers/typescript.ts
+++ b/helpers/typescript.ts
@@ -200,7 +200,7 @@ async function updatePackageJson({
packageJson.name = appName;
packageJson.version = "0.1.0";
- if (dataSources.length > 0 && relativeEngineDestPath) {
+ if (relativeEngineDestPath) {
// TODO: move script to {root}/scripts for all frameworks
// add generate script if using context engine
packageJson.scripts = {
diff --git a/templates/components/engines/python/chat/__init__.py b/templates/components/engines/python/chat/__init__.py
index da1c3cdd..cec97256 100644
--- a/templates/components/engines/python/chat/__init__.py
+++ b/templates/components/engines/python/chat/__init__.py
@@ -9,7 +9,7 @@ def get_chat_engine():
index = get_index()
if index is None:
raise Exception(
- "StorageContext is empty - call 'python app/engine/generate.py' to generate the storage first"
+ "StorageContext is empty - call 'poetry run generate' to generate the storage first"
)
return index.as_chat_engine(
diff --git a/templates/components/vectordbs/python/astra/generate.py b/templates/components/vectordbs/python/astra/generate.py
index 50f11d68..4d2a54af 100644
--- a/templates/components/vectordbs/python/astra/generate.py
+++ b/templates/components/vectordbs/python/astra/generate.py
@@ -15,6 +15,7 @@ logger = logging.getLogger()
def generate_datasource():
+ init_settings()
logger.info("Creating new index")
documents = get_documents()
store = AstraDBVectorStore(
@@ -33,5 +34,4 @@ def generate_datasource():
if __name__ == "__main__":
- init_settings()
generate_datasource()
diff --git a/templates/components/vectordbs/python/milvus/generate.py b/templates/components/vectordbs/python/milvus/generate.py
index 9e674a7d..b5bfc9f9 100644
--- a/templates/components/vectordbs/python/milvus/generate.py
+++ b/templates/components/vectordbs/python/milvus/generate.py
@@ -15,6 +15,7 @@ logger = logging.getLogger()
def generate_datasource():
+ init_settings()
logger.info("Creating new index")
# load the documents and create the index
documents = get_documents()
@@ -35,5 +36,4 @@ def generate_datasource():
if __name__ == "__main__":
- init_settings()
generate_datasource()
diff --git a/templates/components/vectordbs/python/mongo/generate.py b/templates/components/vectordbs/python/mongo/generate.py
index ddc32c5a..abe844c0 100644
--- a/templates/components/vectordbs/python/mongo/generate.py
+++ b/templates/components/vectordbs/python/mongo/generate.py
@@ -15,6 +15,7 @@ logger = logging.getLogger()
def generate_datasource():
+ init_settings()
logger.info("Creating new index")
# load the documents and create the index
documents = get_documents()
@@ -39,5 +40,4 @@ See https://github.com/run-llama/mongodb-demo/tree/main?tab=readme-ov-file#creat
if __name__ == "__main__":
- init_settings()
generate_datasource()
diff --git a/templates/components/vectordbs/python/none/generate.py b/templates/components/vectordbs/python/none/generate.py
index 78fe57be..e38d89cb 100644
--- a/templates/components/vectordbs/python/none/generate.py
+++ b/templates/components/vectordbs/python/none/generate.py
@@ -16,6 +16,7 @@ logger = logging.getLogger()
def generate_datasource():
+ init_settings()
logger.info("Creating new index")
# load the documents and create the index
documents = get_documents()
@@ -28,5 +29,4 @@ def generate_datasource():
if __name__ == "__main__":
- init_settings()
generate_datasource()
diff --git a/templates/components/vectordbs/python/pg/generate.py b/templates/components/vectordbs/python/pg/generate.py
index 5cc93244..79fa3bd7 100644
--- a/templates/components/vectordbs/python/pg/generate.py
+++ b/templates/components/vectordbs/python/pg/generate.py
@@ -15,6 +15,7 @@ logger = logging.getLogger()
def generate_datasource():
+ init_settings()
logger.info("Creating new index")
# load the documents and create the index
documents = get_documents()
@@ -31,5 +32,4 @@ def generate_datasource():
if __name__ == "__main__":
- init_settings()
generate_datasource()
diff --git a/templates/components/vectordbs/python/pinecone/generate.py b/templates/components/vectordbs/python/pinecone/generate.py
index c7ad55ea..5f233ba2 100644
--- a/templates/components/vectordbs/python/pinecone/generate.py
+++ b/templates/components/vectordbs/python/pinecone/generate.py
@@ -15,6 +15,7 @@ logger = logging.getLogger()
def generate_datasource():
+ init_settings()
logger.info("Creating new index")
# load the documents and create the index
documents = get_documents()
@@ -35,5 +36,4 @@ def generate_datasource():
if __name__ == "__main__":
- init_settings()
generate_datasource()
diff --git a/templates/types/streaming/fastapi/README-template.md b/templates/types/streaming/fastapi/README-template.md
index 2ea07212..6af9712b 100644
--- a/templates/types/streaming/fastapi/README-template.md
+++ b/templates/types/streaming/fastapi/README-template.md
@@ -24,7 +24,7 @@ If you are using any tools or data sources, you can update their config files in
Second, generate the embeddings of the documents in the `./data` directory (if this folder exists - otherwise, skip this step):
```
-python app/engine/generate.py
+poetry run generate
```
Third, run the development server:
@@ -84,7 +84,7 @@ docker run \
-v $(pwd)/data:/app/data \ # Use your local folder to read the data
-v $(pwd)/storage:/app/storage \ # Use your file system to store the vector database
<your_backend_image_name> \
- python app/engine/generate.py
+ poetry run generate
```
3. Start the API:
diff --git a/templates/types/streaming/fastapi/pyproject.toml b/templates/types/streaming/fastapi/pyproject.toml
index 5dae9d81..8c087f73 100644
--- a/templates/types/streaming/fastapi/pyproject.toml
+++ b/templates/types/streaming/fastapi/pyproject.toml
@@ -5,6 +5,9 @@ description = ""
authors = ["Marcus Schiesser <mail@marcusschiesser.de>"]
readme = "README.md"
+[tool.poetry.scripts]
+generate = "app.engine.generate:generate_datasource"
+
[tool.poetry.dependencies]
python = "^3.11,<3.12"
fastapi = "^0.109.1"
--
GitLab