Skip to main content

HuggingFace/Datasets is an open library of datasets.

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. Prerequisites:

  2. Change the version in:

    • init.py
    • setup.py
    • docs/source/conf.py
  3. Commit these changes: "git commit -m 'Release: VERSION'"

  4. Add a tag in git to mark the release: "git tag VERSION -m 'Add tag VERSION for pypi'" Push the tag to remote: git push --tags origin master

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

    First, delete any "build" directory that may exist from previous builds.

    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.

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

    twine upload dist/* -r pypitest --repository-url=https://test.pypi.org/legacy/

    Check that you can install it in a virtualenv/notebook by running: pip install huggingface_hub fsspec aiohttp pip install -U tqdm pip install -i https://testpypi.python.org/pypi datasets

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

  8. Fill release notes in the tag in github once everything is looking hunky-dory.

  9. 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 with: "python utils/release.py --version VERSION" Set version to X.X.X+1.dev0 (e.g. 1.8.0 -> 1.8.1.dev0) in:

    • setup.py
    • init.py
  10. Commit these changes: "git commit -m 'Release docs'" Push the commit to remote: "git push origin master"

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

datasets-1.13.3.tar.gz (251.9 kB view hashes)

Uploaded Source

Built Distribution

datasets-1.13.3-py3-none-any.whl (287.1 kB view hashes)

Uploaded Python 3

Supported by

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