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

DOC combine datasets notebooks into one #400

Open
romanlutz opened this issue Sep 26, 2024 · 4 comments
Open

DOC combine datasets notebooks into one #400

romanlutz opened this issue Sep 26, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@romanlutz
Copy link
Contributor

romanlutz commented Sep 26, 2024

Describe the issue linked to the documentation

We started with one notebook per dataset (in the doc/code/orchestrators directory) and now it's becoming a lot. Since they all pretty much follow the same structure we should just have one overall and show the various datasets in their own sections.

Additional Information

Here are the current notebooks about datasets, which should be consolidated into one standard notebook:

@romanlutz romanlutz added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Sep 26, 2024
@bhavanaeh
Copy link

Hi, is the expectation such that you just have one notebook which has all the code for all the datasets?

@nina-msft
Copy link
Contributor

nina-msft commented Oct 4, 2024

Hey @bhavanaeh !

That's the idea. We have one notebook per dataset at the current moment. Roman is asking for one Python Notebook on datasets since they have the same structure. You can then use each Dataset as an example in that notebook.

For example: https://github.com/Azure/PyRIT/blob/main/doc/code/targets/3_custom_targets.ipynb The custom targets notebook is one notebook with several examples.

I'd imagine the Datasets notebook would look similar, with examples for each dataset integration. I just updated the description of the issue to have links to all of the notebooks which currently talk about Datasets.

@bhavanaeh
Copy link

Awesome, thank you so much! If this is still up for grabs, I'd like to take a stab at it :)

@nina-msft
Copy link
Contributor

You got it - thank you @bhavanaeh 🦝

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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants