Skip to main content

HuggingFace is a single library comprising the main HuggingFace libraries.

Project description

Note:

VERSION needs to be formatted following the MAJOR.MINOR.PATCH convention (we need to follow this convention to be able to retrieve versioned scripts)

Simple check list for release from AllenNLP repo: https://github.com/allenai/allennlp/blob/master/setup.py

To create the package for pypi.

  1. Change the version in __init__.py, setup.py as well as docs/source/conf.py.

  2. Commit these changes with the message: “Release: VERSION”

  3. Add a tag in git to mark the release: “git tag VERSION -m’Adds tag VERSION for pypi’ ” Push the tag to git: git push –tags origin master

  4. Build both the sources and the wheel. Do not change anything in setup.py between creating the wheel and the source distribution (obviously).

    For the wheel, run: “python setup.py bdist_wheel” in the top level directory. (this will build a wheel for the python version you use to build it).

    For the sources, run: “python setup.py sdist” You should now have a /dist directory with both .whl and .tar.gz source versions.

    Then change the SCRIPTS_VERSION back to to “master” in __init__.py (but don’t commit this change)

  5. Check that everything looks correct by uploading the package to the pypi test server:

    twine upload dist/* -r pypitest (pypi suggest using twine as other methods upload files via plaintext.) You may have to specify the repository url, use the following command then: twine upload dist/* -r pypitest –repository-url=https://test.pypi.org/legacy/

    Check that you can install it in a virtualenv by running: pip install -i https://testpypi.python.org/pypi datasets

  6. Upload the final version to actual pypi: twine upload dist/* -r pypi

  7. Copy the release notes from RELEASE.md to the tag in github once everything is looking hunky-dory.

  8. Update the documentation commit in .circleci/deploy.sh for the accurate documentation to be displayed Update the version mapping in docs/source/_static/js/custom.js

  9. Update README.md to redirect to correct documentation.

Project details


Download files

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

Files for huggingface, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size huggingface-0.0.1-py3-none-any.whl (2.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size huggingface-0.0.1.tar.gz (2.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page