diff --git a/README.md b/README.md index 00730fb..28f0041 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # Context retrieval example -### [de_wiki_context.py](de_wiki_context.py) +## [de_wiki_context.py](de_wiki_context.py) -- Pulze key is required in the `.env` file -- Running it for the first time will download the de-wiki dataset and compute the embeddings +- Pulze key is required in the `.env` file for access to the `pulze` model +- Langfuse key is required in the `.env` file for observability +- The first time will download the dataset and compute the embeddings - You can set `EMBEDDINGS_HOW_MANY_K` to a lower value if you don't want to wait - Embeddings are cached in the `data/` folder - A few sample questions are provided + +## [gen_context.py](gen_context.py) + +This will process all the questions from the main project. diff --git a/justfile b/justfile index fb00f41..51df77a 100644 --- a/justfile +++ b/justfile @@ -14,6 +14,7 @@ fmt: # lint Markdown, YAML and Python files lint: yamllint --config-file .github/linters/.yaml-lint.yml -- {{yaml_files}} + markdownlint -- {{markdown_files}} prettier --check -- {{markdown_files}} {{yaml_files}} flake8 --config .github/linters/.flake8 -- {{python_files}} isort --settings-path .github/linters/.isort.cfg --check --diff -- {{python_files}}