-
Notifications
You must be signed in to change notification settings - Fork 122
Added documentation for the config file #125
Conversation
It's not perfect, but it will do for now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good
config/config.yaml
Outdated
# The context builder is responsible for formulating a textual context given query results. | ||
# ------------------------------------------------------------------------- | ||
context_builder: | ||
type: StuffingContextBuilder |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...In tokens
There was a problem hiding this comment.
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
It's not perfect, but it will do for now