You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The example and the two related text references in this section need to be updated (eg see the first sentence of this section).
NB: Minor but there is also a typo in the example saying "from deepeval.synthesizer.confg ..." instead of "config".
Summary of updates needed:
The two class name references in this section should be updated, and the full example should be updated from:
@penguine-ip
There are two separate pages that need to be corrected + one possible addition to cover off an undocumented parameter:
The example under https://docs.confident-ai.com/docs/synthesizer-introduction#filteration-quality
is wrongly referencing Synthesizer(filteration_config=...) when it should be filtration_config. That is removal of "e" in the spelling.
And the object instance probably should consistently be renamed accordingly (to avoid naming confusion).
The full example would become:
Finally the Title of this section and URL reference to jump to this section should be updated accordingly from:
https://docs.confident-ai.com/docs/synthesizer-introduction#filteration-quality
to
https://docs.confident-ai.com/docs/synthesizer-introduction#filtration-quality
(or similar)
The section under https://docs.confident-ai.com/docs/synthesizer-generate-from-docs#customize-context-construction
wrongly references ContextExtractionConfig whereas the actual class in synthesizer/config.py has defined the
class ContextConstructionConfig.
The example and the two related text references in this section need to be updated (eg see the first sentence of this section).
NB: Minor but there is also a typo in the example saying "from deepeval.synthesizer.confg ..." instead of "config".
Summary of updates needed:
The two class name references in this section should be updated, and the full example should be updated from:
To:
There is an undocumented optional parameter for generate_goldens_from_contexts method being source_files that you might like to now document under the relevant section.
URL = https://docs.confident-ai.com/docs/synthesizer-generate-from-contexts#generate-your-goldens
Could add new bullet point:
(or similar wording)
The text was updated successfully, but these errors were encountered: