davidtvs / pytorch-lr-finder

A learning rate range test implementation in PyTorch
MIT License
912 stars 116 forks source link

New release for pip? #97

Open carbocation opened 1 month ago

carbocation commented 1 month ago

The current instructions suggest pip-installing, but the (pip-installed code seems to be from 2020](https://pypi.org/project/torch-lr-finder/#history), missing all of the recent changes. It seems to be tracking the package releases, which were last updated in 2020 as well. Can a new release be cut?

NaleRaphael commented 1 month ago

The release process is maintained by David, we might need to wait until he is available. However, if the version information does not quite matter in your use case, you can still get the latest update by:

# 1. Installing from this git repository directly
$ git clone https://github.com/davidtvs/pytorch-lr-finder
$ cd pytorch-lr-finder
$ pip install .

# 2. Run pip and specify a git URL
$ pip install git+https://github.com/davidtvs/pytorch-lr-finder.git
#    To specific a revision, append a commit hash like this:
$ pip install git+https://github.com/davidtvs/pytorch-lr-finder.git@fd9e949bc709e31881c77a4b0710745524c5091e

But please note that the version shown in $ pip show torch-lr-finder still depends on setup.py.

Hi @davidtvs, here is a brief summary for the new release, hope this could help (hash signs for PR and issue are removed here to avoid adding noise by cross reference):

Within these updates, there are no breaking changes to API. But we added new keyword arguments for selecting backend for mixed precision training in PR 91, so bumping the minor version would be suggested. If there is any further thing need to be solved before the new release, please feel free to let me know!

davidtvs commented 3 weeks ago

I will create a new release once we merge #98 . Thanks @NaleRaphael for the help!