Skip to content

Improved README.pypi.md #257

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Dec 4, 2024
Merged

Improved README.pypi.md #257

merged 3 commits into from
Dec 4, 2024

Conversation

validbeck
Copy link
Collaborator

Internal Notes for Reviewers

sc-1369

I improved the README for our PyPI page. I believe the page gets updated on the PyPI website when we push the changes to prod (But @cachafla will have to confirm...).

Screenshot 2024-12-03 at 2 37 10 PM

@validbeck validbeck added the internal Not to be externalized in the release notes label Dec 3, 2024
@validbeck validbeck self-assigned this Dec 3, 2024
cachafla
cachafla approved these changes Dec 4, 2024
View reviewed changes
Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

Great 👏

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 4, 2024

PR Summary

This pull request enhances the README.pypi.md file by adding a comprehensive overview of the ValidMind platform and its components. The new sections provide detailed information about the ValidMind Library and Platform, including how they help developers, data scientists, and compliance stakeholders manage AI model risks and documentation. Additionally, it includes instructions on getting started with ValidMind and exploring code samples through Jupyter Notebooks.

The PR also updates the version number from 2.6.4 to 2.6.5 in the pyproject.toml and validmind/__version__.py files.

Test Suggestions

  • Verify that the new sections in the README are correctly formatted and contain accurate information.
  • Check that all links in the README are functional and direct to the correct resources.
  • Ensure that the version update does not affect any existing functionality or dependencies.

@validbeck validbeck merged commit bb2be2b into main Dec 4, 2024
6 checks passed
@validbeck validbeck deleted the beck/sc-1369/improve-project-description-for-validmind branch December 4, 2024 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cachafla cachafla cachafla approved these changes

@nrichers nrichers Awaiting requested review from nrichers

Assignees

@validbeck validbeck

Labels
internal Not to be externalized in the release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@validbeck @cachafla