Skip to main content

EarlyStopping: Implicit Regularisation for Iterative Learning Procedures in Python

Project description

Early stopping

Early stopping is a python library implementing computationally efficient model selection methods for iterative estimation procedures based on the theory in

Check out the documentation for more information.

Development notes

Installation for development

Required dependencies: git, Python3, JupyterNotebooks.

Manual setup:

python3 -m pip install build virtualenv               # Install build tools
git clone https://github.com/ESFIEP/EarlyStopping.git # Clone git repository
python3 -m build                                      # Build package
python3 -m venv myenv                                 # Create virtual environment
source myenv/bin/activate                             # Activate virtual environment
python3 -m pip install numpy ipykernel                # Install python packages to the environment
python3 -m pip install -e .                           # Install the EarlyStopping package in editable mode
python3 -m ipykernel install --user --name=myenv      # Create Jupyter kernel from the environment

From the notebooks directory open the Jupyter notebook example.ipynb with the kernel myenv and run the code!

Installation from Python Package Index

https://test.pypi.org/project/EarlyStopping

Creating documentation locally

The online documentation is not built until it has been merged into main. To build documentation locally and check how things look run

sphinx-build -M html docs/source docs/build

in the EarlyStopping directory. The documentation will be generated in docs/build/html. To view them locally open index.html with firefox or another browser. Information about about documenting projects with sphinx.

Under Linux, it was necessary to include

import os
import sys
sys.path.insert(0, os.path.abspath('../../src'))

in docs/source/conf.py. Please only include this locally and never push the change.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

earlystoppingpy-0.0.4.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

earlystoppingpy-0.0.4-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

Details for the file earlystoppingpy-0.0.4.tar.gz.

File metadata

  • Download URL: earlystoppingpy-0.0.4.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for earlystoppingpy-0.0.4.tar.gz
Algorithm Hash digest
SHA256 6dca54824a326963a1b6f66e88365db42a09dcf0c77dbb61a1c7621d228856eb
MD5 fcc7b06d878d49df8249b2ca7f6e92c1
BLAKE2b-256 758be8af115a890959ff14cd92736b1736326d5f127f78148dd02e6cedf82915

See more details on using hashes here.

Provenance

The following attestation bundles were made for earlystoppingpy-0.0.4.tar.gz:

Publisher: pypi.yaml on EarlyStop/EarlyStopping

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file earlystoppingpy-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for earlystoppingpy-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ec497d2267c5b27945d082f5c3e72a8220f57f2cc3591ff85157c7be5acfc063
MD5 845a2cf01fce5d0260767630a955d491
BLAKE2b-256 cbb0f06c5b25d26d12f40e6edb1d277844549aacf6c97452a56a04109a4032e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for earlystoppingpy-0.0.4-py3-none-any.whl:

Publisher: pypi.yaml on EarlyStop/EarlyStopping

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page