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

Add FAQ.md to provide sample estimation guidelines #408

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

relyt0925
Copy link
Contributor

@relyt0925 relyt0925 commented Nov 25, 2024

The new FAQ.md file includes detailed explanations and examples on how to estimate the number of synthetic samples produced at various stages of the SDG training process. This addition aims to enhance user understanding of the sample generation methodology.

I believe it's an MVP to resolving: #307

@mergify mergify bot added documentation Improvements or additions to documentation ci-failure labels Nov 25, 2024
@relyt0925 relyt0925 force-pushed the faq-size branch 5 times, most recently from b31ff34 to 1f568eb Compare November 25, 2024 05:06
@mergify mergify bot removed the ci-failure label Nov 25, 2024
@aakankshaduggal aakankshaduggal requested a review from a team December 6, 2024 18:21
For each knowledge leaf node: the formula to estimate the number of produced synthetic samples in the training dataset is:

```text
(total cumulative size of knowledge documents / max document chunk size) * number of qna pairs in the knowledge file leaf node * 30 synthetic samples per qna pair
Copy link
Member

Choose a reason for hiding this comment

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

Does this factor in the amount of samples that will be filtered out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@RobotSail this is an excellent point: it does not since that part is non detemenistic to a certain extent: but folks have been looking to be able to get some guidance on some ball park numbers/ answers to general questions around how the taxonomy is processed through SDG

I should call that out as a disclaimer and will do that

The new FAQ.md file includes detailed explanations and examples on how to estimate the number of synthetic samples produced at various stages of the SDG training process. This addition aims to enhance user understanding of the sample generation methodology.

Signed-off-by: Tyler Lisowski <[email protected]>
@relyt0925
Copy link
Contributor Author

These are a good initial set of FAQs that we have seen pop up with what I feel (based on my studies of the codebase) are the appropriate answers. More than happy to adjust anything that is inaccurate though based on expert opinion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants