Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Separation of examples into different folders to avoid confusion #228

Open
azygadlo opened this issue Dec 2, 2024 · 0 comments
Open
Labels
feature New feature or request

Comments

@azygadlo
Copy link
Collaborator

azygadlo commented Dec 2, 2024

Feature description

Currently, all document search examples such as evaluate.py, ingest.py and optimize.py are stored in the same folder. Their configs also share the same directory. I would suggest to have separate folders for evaluation and optimization examples (in future, if we have multiple evaluation examples, each of them should have a separate subfolder).

We also want to keep an index of existing examples in README file and also mention level of example complexity there.

Motivation

I want to avoid confusion in familiarization with examples. I believe better example separation would help.

Additional context

No response

@azygadlo azygadlo added the feature New feature or request label Dec 2, 2024
@azygadlo azygadlo changed the title feat: Separation of document search evaluation examples into different folders to avoid confusion feat: Separation of examples into different folders to avoid confusion Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant