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

Binary classifier notebook documentation update #10

Merged

Conversation

MahmoodEtedadi
Copy link
Contributor

@MahmoodEtedadi MahmoodEtedadi commented May 23, 2024

Clarify assumptions about the required files to run the example notebook, closes #8.

@CLAassistant
Copy link

CLAassistant commented May 23, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@nhayes-rich nhayes-rich left a comment

Choose a reason for hiding this comment

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

Do you want to also add a section at the top of the example notebooks rst file explaining the breakdown of the files (i.e., which one is where and why they're separate)?

@diehlbw
Copy link
Collaborator

diehlbw commented May 23, 2024

Can you create a newsfragment for this and reference the issue?
My PR just snuck in which starts enforcing these

docs/example_notebooks/index.rst Outdated Show resolved Hide resolved
docs/example_notebooks/index.rst Outdated Show resolved Hide resolved
docs/example_notebooks/index.rst Outdated Show resolved Hide resolved
MahmoodEtedadi and others added 3 commits May 23, 2024 17:06
Co-authored-by: nhayes-rich <nhayesrich@gmail.com>
Co-authored-by: nhayes-rich <nhayesrich@gmail.com>
Co-authored-by: nhayes-rich <nhayesrich@gmail.com>
@nhayes-rich nhayes-rich added the documentation Improvements or additions to documentation label May 23, 2024
Co-authored-by: nhayes-rich <nhayesrich@gmail.com>
nhayes-rich
nhayes-rich previously approved these changes May 23, 2024
@MahmoodEtedadi MahmoodEtedadi merged commit 3a6d633 into epic-open-source:main May 23, 2024
4 checks passed
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.

missing full config data in Binary Classifier Notebook example
4 participants