Skip to content

Commit

Permalink
Fix markdownlint issues
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyannn committed Jan 9, 2024
1 parent 0b7be89 commit 8fa5714
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down

0 comments on commit 8fa5714

Please sign in to comment.