xbatcher


Namexbatcher JSON
Version 0.4.0 PyPI version JSON
download
home_pageNone
SummaryBatch generation from Xarray objects
upload_time2024-09-17 21:54:42
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseApache
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            xbatcher: Batch Generation from Xarray Datasets
===============================================

|Build Status| |codecov| |docs| |pypi| |conda-forge| |license|


Xbatcher is a small library for iterating Xarray DataArrays and Datasets in
batches. The goal is to make it easy to feed Xarray objects to machine
learning libraries such as PyTorch_ or TensorFlow_. View the |docs| for more
info.

.. _TensorFlow: https://www.tensorflow.org/

.. _PyTorch: https://pytorch.org/


.. |Build Status| image:: https://github.com/xarray-contrib/xbatcher/workflows/CI/badge.svg
   :target: https://github.com/xarray-contrib/xbatcher/actions
   :alt: github actions build status
.. |codecov| image:: https://codecov.io/gh/xarray-contrib/xbatcher/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/xarray-contrib/xbatcher
   :alt: code coverage
.. |docs| image:: http://readthedocs.org/projects/xbatcher/badge/?version=latest
   :target: http://xbatcher.readthedocs.org/en/latest/?badge=latest
   :alt: docs
.. |pypi| image:: https://img.shields.io/pypi/v/xbatcher.svg
   :target: https://pypi.python.org/pypi/xbatcher
   :alt: pypi
.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/xbatcher.svg
   :target: https://anaconda.org/conda-forge/xbatcher
   :alt: conda-forge
.. |license| image:: https://img.shields.io/github/license/xarray-contrib/xbatcher.svg
   :target: https://github.com/xarray-contrib/xbatcher
   :alt: license

Installation
------------

Xbatcher can be installed from PyPI as::

    python -m pip install xbatcher

Or via Conda as::

    conda install -c conda-forge xbatcher

Or from source as::

    python -m pip install git+https://github.com/xarray-contrib/xbatcher.git

.. note::
   The required dependencies installed with Xbatcher are `Xarray <https://xarray.dev/>`_,
   `Dask <https://www.dask.org/>`_, and `NumPy <https://numpy.org/>`_.
   You will need to separately install `TensorFlow <https://www.tensorflow.org/>`_
   or `PyTorch <https://pytorch.org/>`_ to use those data loaders or
   Xarray accessors. `Review the installation instructions <https://xbatcher.readthedocs.io/en/latest/#optional-dependencies>`_
   for more details.

Documentation
-------------

Documentation is hosted on ReadTheDocs: https://xbatcher.readthedocs.org

License
------------

Apache License 2.0, see LICENSE file.

Acknowledgements
----------------

This work was funded in part by:

NASA ACCESS19-0049: Pangeo ML: Open Source Tools and Pipelines for Scalable Machine Learning Using NASA Earth Observation Data

This work was motivated by many conversations in the Pangeo community and Pangeo ML working group

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "xbatcher",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "xbatcher Developers <rpa@ldeo.columbia.edu>",
    "download_url": "https://files.pythonhosted.org/packages/9f/bf/28661c7535fa29cac2236a3854ea976668ab2e9dcc2d893f3fa2260a6161/xbatcher-0.4.0.tar.gz",
    "platform": null,
    "description": "xbatcher: Batch Generation from Xarray Datasets\n===============================================\n\n|Build Status| |codecov| |docs| |pypi| |conda-forge| |license|\n\n\nXbatcher is a small library for iterating Xarray DataArrays and Datasets in\nbatches. The goal is to make it easy to feed Xarray objects to machine\nlearning libraries such as PyTorch_ or TensorFlow_. View the |docs| for more\ninfo.\n\n.. _TensorFlow: https://www.tensorflow.org/\n\n.. _PyTorch: https://pytorch.org/\n\n\n.. |Build Status| image:: https://github.com/xarray-contrib/xbatcher/workflows/CI/badge.svg\n   :target: https://github.com/xarray-contrib/xbatcher/actions\n   :alt: github actions build status\n.. |codecov| image:: https://codecov.io/gh/xarray-contrib/xbatcher/branch/main/graph/badge.svg\n   :target: https://codecov.io/gh/xarray-contrib/xbatcher\n   :alt: code coverage\n.. |docs| image:: http://readthedocs.org/projects/xbatcher/badge/?version=latest\n   :target: http://xbatcher.readthedocs.org/en/latest/?badge=latest\n   :alt: docs\n.. |pypi| image:: https://img.shields.io/pypi/v/xbatcher.svg\n   :target: https://pypi.python.org/pypi/xbatcher\n   :alt: pypi\n.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/xbatcher.svg\n   :target: https://anaconda.org/conda-forge/xbatcher\n   :alt: conda-forge\n.. |license| image:: https://img.shields.io/github/license/xarray-contrib/xbatcher.svg\n   :target: https://github.com/xarray-contrib/xbatcher\n   :alt: license\n\nInstallation\n------------\n\nXbatcher can be installed from PyPI as::\n\n    python -m pip install xbatcher\n\nOr via Conda as::\n\n    conda install -c conda-forge xbatcher\n\nOr from source as::\n\n    python -m pip install git+https://github.com/xarray-contrib/xbatcher.git\n\n.. note::\n   The required dependencies installed with Xbatcher are `Xarray <https://xarray.dev/>`_,\n   `Dask <https://www.dask.org/>`_, and `NumPy <https://numpy.org/>`_.\n   You will need to separately install `TensorFlow <https://www.tensorflow.org/>`_\n   or `PyTorch <https://pytorch.org/>`_ to use those data loaders or\n   Xarray accessors. `Review the installation instructions <https://xbatcher.readthedocs.io/en/latest/#optional-dependencies>`_\n   for more details.\n\nDocumentation\n-------------\n\nDocumentation is hosted on ReadTheDocs: https://xbatcher.readthedocs.org\n\nLicense\n------------\n\nApache License 2.0, see LICENSE file.\n\nAcknowledgements\n----------------\n\nThis work was funded in part by:\n\nNASA ACCESS19-0049: Pangeo ML: Open Source Tools and Pipelines for Scalable Machine Learning Using NASA Earth Observation Data\n\nThis work was motivated by many conversations in the Pangeo community and Pangeo ML working group\n",
    "bugtrack_url": null,
    "license": "Apache",
    "summary": "Batch generation from Xarray objects",
    "version": "0.4.0",
    "project_urls": {
        "documentation": "https://xbatcher.readthedocs.io/en/latest/",
        "repository": "https://github.com/xarray-contrib/xbatcher"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "85f09a67b054cd767e3beddb439969c30d885b59b617d743dda5e01efb693ee4",
                "md5": "e7f171bd5a62502b92583ed92005d9c4",
                "sha256": "a52dfa4e772c83f7a1937261c9a51cba656edefd09f5ffd780f62da2ad0dbea2"
            },
            "downloads": -1,
            "filename": "xbatcher-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e7f171bd5a62502b92583ed92005d9c4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 24100,
            "upload_time": "2024-09-17T21:54:41",
            "upload_time_iso_8601": "2024-09-17T21:54:41.625262Z",
            "url": "https://files.pythonhosted.org/packages/85/f0/9a67b054cd767e3beddb439969c30d885b59b617d743dda5e01efb693ee4/xbatcher-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9fbf28661c7535fa29cac2236a3854ea976668ab2e9dcc2d893f3fa2260a6161",
                "md5": "7b733b33a4b22b40d9be27e702fb3fa0",
                "sha256": "6744005c76699659586a92d35a497e327749b37aa441e941c07a696ec99b6a8f"
            },
            "downloads": -1,
            "filename": "xbatcher-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7b733b33a4b22b40d9be27e702fb3fa0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 50836,
            "upload_time": "2024-09-17T21:54:42",
            "upload_time_iso_8601": "2024-09-17T21:54:42.787535Z",
            "url": "https://files.pythonhosted.org/packages/9f/bf/28661c7535fa29cac2236a3854ea976668ab2e9dcc2d893f3fa2260a6161/xbatcher-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-17 21:54:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "xarray-contrib",
    "github_project": "xbatcher",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "xbatcher"
}
        
Elapsed time: 0.60826s