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

Various additions to the README #16

Merged
merged 8 commits into from Sep 26, 2019
Merged

Various additions to the README #16

merged 8 commits into from Sep 26, 2019

Conversation

denver1117
Copy link
Contributor

@denver1117 denver1117 commented Sep 26, 2019

README Additions

Description

Add grid search diagram, key examples, and past contributors to the README

Motivation and Context

The image is a useful visual representation of the under the hood details of sk-dist for a popular use case.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added reviewers to the PR.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@@ -134,13 +138,17 @@ With ``pytest`` installed, you can run tests locally:
pytest sk-dist

Examples
^^^^^^^^
--------
Copy link
Contributor

Choose a reason for hiding this comment

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

💯

@denver1117 denver1117 merged commit 11f2acc into master Sep 26, 2019
@denver1117 denver1117 deleted the readme_enhancements branch September 26, 2019 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants