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

Document and add examples for each Block type #415

Open
Tracked by #373
bbrowning opened this issue Nov 27, 2024 · 2 comments
Open
Tracked by #373

Document and add examples for each Block type #415

bbrowning opened this issue Nov 27, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@bbrowning
Copy link
Contributor

We need to document what each Block type does - new and old ones - as well as add examples for how to use them from a pipeline config. This could be an entire section of our README.md or broken out into a separate document that we link to from README.md.

@asaluja-rh
Copy link

@bbrowning whenever we do this, can we extend this to also document num_samples for custom skills, allowing user to tweak skill knobs, making skills more useful to the end user.

@bbrowning bbrowning added the documentation Improvements or additions to documentation label Jan 21, 2025
@bbrowning
Copy link
Contributor Author

Providing simple examples of how to use the various block types requires us to add a simple CLI in SDG to run a single data generation pipeline, inspired from the one the research team uses in their work.

A PR for that is at #492 and once that merges we can start adding a lot more examples of Pipelines, Blocks, etc for all the different options we support. That PR includes a way to run every example as an automated test, so we ensure the examples all work and continue to work as we change things.

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

No branches or pull requests

2 participants