Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Added documentation for the config file #125

Merged
merged 4 commits into from
Oct 31, 2023
Merged

Conversation

igiloh-pinecone
Copy link
Contributor

It's not perfect, but it will do for now

Copy link
Contributor

@miararoy miararoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good

# The context builder is responsible for formulating a textual context given query results.
# -------------------------------------------------------------------------
context_builder:
type: StuffingContextBuilder
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explain where is the expected location of this class, filename etc

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For all the other classes (Chunker etc) I simply added a list of all options (most of those lists only have one item for now...).
I'll do the same here. Thanks!

chunk_overlap: 0
keep_separator: true
chunk_size: 256 # The maximum number of tokens in each chunk
chunk_overlap: 0 # The number of tokens to overlap between chunks
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...In tokens

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

It says number of tokens, I'm not sure I'm following

@igiloh-pinecone igiloh-pinecone added this pull request to the merge queue Oct 30, 2023
@igiloh-pinecone igiloh-pinecone removed this pull request from the merge queue due to a manual request Oct 30, 2023
@igiloh-pinecone igiloh-pinecone added this pull request to the merge queue Oct 31, 2023
Merged via the queue into dev with commit a85e384 Oct 31, 2023
10 checks passed
@igiloh-pinecone igiloh-pinecone deleted the document_config branch October 31, 2023 10:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants