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

chore!: rename package, restructure files, and add pip integration #29

Merged
merged 13 commits into from
Oct 16, 2024

Conversation

Bjarten
Copy link
Owner

@Bjarten Bjarten commented Oct 16, 2024

This update introduces significant changes to the project, including renaming the package, restructuring the directory, and setting up automated publishing to PyPI using API tokens.

Key Changes:

  1. Package Renaming:

    • The package has been renamed from pytorchtools to early_stopping_pytorch for clearer naming and better alignment with its functionality.
  2. Directory Restructuring:

    • Project files have been reorganized for clarity, with the source code placed under the early_stopping_pytorch/ directory in the root of the project.
  3. PyPI Integration:

    • Added support for automated publishing to PyPI using GitHub Actions.
    • API tokens are used for secure publishing, stored as GitHub Secrets (PYPI_TOKEN).

Impact:

  • Breaking Changes: Users will need to update their import paths from:

    from pytorchtools import EarlyStopping

    to:

    from early_stopping_pytorch import EarlyStopping
  • New versions will be automatically published to PyPI when a new tag is pushed, using the API token for authentication.

@Bjarten Bjarten merged commit f9522dd into main Oct 16, 2024
5 checks passed
@Bjarten Bjarten deleted the chore/setup-packaging branch October 16, 2024 06:56
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.

1 participant