tfx-bsl


Nametfx-bsl JSON
Version 0.28.1 PyPI version JSON
download
home_pagehttps://www.tensorflow.org/tfx
Summarytfx_bsl (TFX Basic Shared Libraries) contains libraries shared by many TFX (TensorFlow eXtended) libraries and components.
upload_time2021-02-23 17:41:42
maintainer
docs_urlNone
authorGoogle LLC
requires_python>=3.6,<4
licenseApache 2.0
keywords tfx bsl
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # TFX Basic Shared Libraries

[![Python](https://img.shields.io/pypi/pyversions/tfx-bsl.svg?style=plastic)](https://github.com/tensorflow/tfx-bsl)
[![PyPI](https://badge.fury.io/py/tfx-bsl.svg)](https://badge.fury.io/py/tfx-bsl)

TFX Basic Shared Libraries (`tfx_bsl`) contains libraries shared by many
[TensorFlow eXtended (TFX)](https://www.tensorflow.org/tfx) components.

__Only symbols exported by sub-modules under `tfx_bsl/public` are intended for
direct use by TFX users__, including by standalone TFX library (e.g. TFDV, TFMA,
TFT) users, TFX pipeline authors and TFX component authors. Those APIs will
become stable and follow semantic versioning once `tfx_bsl` goes beyond `1.0`.

APIs under other directories should be considered internal to TFX
(and therefore there is no backward or forward compatibility guarantee for
them).

Each minor version of a TFX library or TFX itself, if it needs to
depend on `tfx_bsl`, will depend on a specific minor version of it (e.g.
`tensorflow_data_validation` 0.14.\* will depend on, and only work with,
`tfx_bsl` 0.14.\*)

## Installing from PyPI

`tfx_bsl` is available as a [PyPI package](https://pypi.org/project/tfx-bsl/).

```bash
pip install tfx-bsl
```

### Nightly Packages

TFX-BSL also hosts nightly packages at https://pypi-nightly.tensorflow.org on
Google Cloud. To install the latest nightly package, please use the following
command:

```bash
pip install -i https://pypi-nightly.tensorflow.org/simple tfx-bsl
```

This will install the nightly packages for the major dependencies of TFX-BSL
such as TensorFlow Metadata (TFMD).

However it is a dependency of many TFX components and usually as a user you
don't need to install it directly.

## Build with Docker

If you want to build a TFX component from the master branch, past the latest
release, you may also have to build the latest `tfx_bsl`, as that TFX component
might have depended on new features introduced past the latest `tfx_bsl`
release.

Building from Docker is the recommended way to build `tfx_bsl` under Linux,
and is continuously tested at Google.

### 1. Install Docker

Please first install [`docker`](https://docs.docker.com/install/) and
[`docker-compose`](https://docs.docker.com/compose/install/) by following the
directions.

### 2. Clone the `tfx_bsl` repository

```shell
git clone https://github.com/tensorflow/tfx-bsl
cd tfx-bsl
```

Note that these instructions will install the latest master branch of `tfx-bsl`.
If you want to install a specific branch (such as a release branch), pass
`-b <branchname>` to the `git clone` command.

### 3. Build the pip package

Then, run the following at the project root:

```bash
sudo docker-compose build manylinux2010
sudo docker-compose run -e PYTHON_VERSION=${PYTHON_VERSION} manylinux2010
```
where `PYTHON_VERSION` is one of `{35, 36, 37, 38}`.

A wheel will be produced under `dist/`.

### 4. Install the pip package

```shell
pip install dist/*.whl
```

## Build from source

### 1. Prerequisites

#### Install NumPy

If NumPy is not installed on your system, install it now by following [these
directions](https://www.scipy.org/scipylib/download.html).

#### Install Bazel

If Bazel is not installed on your system, install it now by following [these
directions](https://bazel.build/versions/master/docs/install.html).


### 2. Clone the `tfx_bsl` repository

```shell
git clone https://github.com/tensorflow/tfx-bsl
cd tfx-bsl
```

Note that these instructions will install the latest master branch of `tfx_bsl`
If you want to install a specific branch (such as a release branch),
pass `-b <branchname>` to the `git clone` command.

### 3. Build the pip package

`tfx_bsl` wheel is Python version dependent -- to build the pip package that
works for a specific Python version, use that Python binary to run:
```shell
python setup.py bdist_wheel
```

You can find the generated `.whl` file in the `dist` subdirectory.

### 4. Install the pip package

```shell
pip install dist/*.whl
```

## Supported platforms

`tfx_bsl` is tested on the following 64-bit operating systems:

  * macOS 10.12.6 (Sierra) or later.
  * Ubuntu 16.04 or later.
  * Windows 7 or later.


## Compatible versions

The following table is the `tfx_bsl` package versions that are compatible with
each other. This is determined by our testing framework, but other *untested*
combinations may also work.

tfx-bsl                                                                         | apache-beam[gcp] | pyarrow  | tensorflow        | tensorflow-metadata | tensorflow-serving-api |
------------------------------------------------------------------------------- | -----------------| ---------|-------------------|---------------------|------------------------|
[GitHub master](https://github.com/tensorflow/tfx-bsl/blob/master/RELEASE.md)   | 2.28.0           | 2.0.0    | nightly (1.x/2.x) | 0.28.0              | 2.4.0                  |
[0.28.0](https://github.com/tensorflow/tfx-bsl/blob/v0.28.0/RELEASE.md)         | 2.28.0           | 2.0.0    | 1.15 / 2.4        | 0.28.0              | 2.4.0                  |
[0.27.1](https://github.com/tensorflow/tfx-bsl/blob/v0.27.1/RELEASE.md)         | 2.27.0           | 2.0.0    | 1.15 / 2.4        | 0.27.0              | 2.4.0                  |
[0.27.0](https://github.com/tensorflow/tfx-bsl/blob/v0.27.0/RELEASE.md)         | 2.27.0           | 2.0.0    | 1.15 / 2.4        | 0.27.0              | 2.4.0                  |
[0.26.1](https://github.com/tensorflow/tfx-bsl/blob/v0.26.1/RELEASE.md)         | 2.25.0           | 0.17.0   | 1.15 / 2.3        | 0.27.0              | 2.3.0                  |
[0.26.0](https://github.com/tensorflow/tfx-bsl/blob/v0.26.0/RELEASE.md)         | 2.25.0           | 0.17.0   | 1.15 / 2.3        | 0.27.0              | 2.3.0                  |



            

Raw data

            {
    "_id": null,
    "home_page": "https://www.tensorflow.org/tfx",
    "name": "tfx-bsl",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6,<4",
    "maintainer_email": "",
    "keywords": "tfx bsl",
    "author": "Google LLC",
    "author_email": "tensorflow-extended-dev@googlegroups.com",
    "download_url": "https://github.com/tensorflow/tfx-bsl/tags",
    "platform": "",
    "description": "# TFX Basic Shared Libraries\n\n[![Python](https://img.shields.io/pypi/pyversions/tfx-bsl.svg?style=plastic)](https://github.com/tensorflow/tfx-bsl)\n[![PyPI](https://badge.fury.io/py/tfx-bsl.svg)](https://badge.fury.io/py/tfx-bsl)\n\nTFX Basic Shared Libraries (`tfx_bsl`) contains libraries shared by many\n[TensorFlow eXtended (TFX)](https://www.tensorflow.org/tfx) components.\n\n__Only symbols exported by sub-modules under `tfx_bsl/public` are intended for\ndirect use by TFX users__, including by standalone TFX library (e.g. TFDV, TFMA,\nTFT) users, TFX pipeline authors and TFX component authors. Those APIs will\nbecome stable and follow semantic versioning once `tfx_bsl` goes beyond `1.0`.\n\nAPIs under other directories should be considered internal to TFX\n(and therefore there is no backward or forward compatibility guarantee for\nthem).\n\nEach minor version of a TFX library or TFX itself, if it needs to\ndepend on `tfx_bsl`, will depend on a specific minor version of it (e.g.\n`tensorflow_data_validation` 0.14.\\* will depend on, and only work with,\n`tfx_bsl` 0.14.\\*)\n\n## Installing from PyPI\n\n`tfx_bsl` is available as a [PyPI package](https://pypi.org/project/tfx-bsl/).\n\n```bash\npip install tfx-bsl\n```\n\n### Nightly Packages\n\nTFX-BSL also hosts nightly packages at https://pypi-nightly.tensorflow.org on\nGoogle Cloud. To install the latest nightly package, please use the following\ncommand:\n\n```bash\npip install -i https://pypi-nightly.tensorflow.org/simple tfx-bsl\n```\n\nThis will install the nightly packages for the major dependencies of TFX-BSL\nsuch as TensorFlow Metadata (TFMD).\n\nHowever it is a dependency of many TFX components and usually as a user you\ndon't need to install it directly.\n\n## Build with Docker\n\nIf you want to build a TFX component from the master branch, past the latest\nrelease, you may also have to build the latest `tfx_bsl`, as that TFX component\nmight have depended on new features introduced past the latest `tfx_bsl`\nrelease.\n\nBuilding from Docker is the recommended way to build `tfx_bsl` under Linux,\nand is continuously tested at Google.\n\n### 1. Install Docker\n\nPlease first install [`docker`](https://docs.docker.com/install/) and\n[`docker-compose`](https://docs.docker.com/compose/install/) by following the\ndirections.\n\n### 2. Clone the `tfx_bsl` repository\n\n```shell\ngit clone https://github.com/tensorflow/tfx-bsl\ncd tfx-bsl\n```\n\nNote that these instructions will install the latest master branch of `tfx-bsl`.\nIf you want to install a specific branch (such as a release branch), pass\n`-b <branchname>` to the `git clone` command.\n\n### 3. Build the pip package\n\nThen, run the following at the project root:\n\n```bash\nsudo docker-compose build manylinux2010\nsudo docker-compose run -e PYTHON_VERSION=${PYTHON_VERSION} manylinux2010\n```\nwhere `PYTHON_VERSION` is one of `{35, 36, 37, 38}`.\n\nA wheel will be produced under `dist/`.\n\n### 4. Install the pip package\n\n```shell\npip install dist/*.whl\n```\n\n## Build from source\n\n### 1. Prerequisites\n\n#### Install NumPy\n\nIf NumPy is not installed on your system, install it now by following [these\ndirections](https://www.scipy.org/scipylib/download.html).\n\n#### Install Bazel\n\nIf Bazel is not installed on your system, install it now by following [these\ndirections](https://bazel.build/versions/master/docs/install.html).\n\n\n### 2. Clone the `tfx_bsl` repository\n\n```shell\ngit clone https://github.com/tensorflow/tfx-bsl\ncd tfx-bsl\n```\n\nNote that these instructions will install the latest master branch of `tfx_bsl`\nIf you want to install a specific branch (such as a release branch),\npass `-b <branchname>` to the `git clone` command.\n\n### 3. Build the pip package\n\n`tfx_bsl` wheel is Python version dependent -- to build the pip package that\nworks for a specific Python version, use that Python binary to run:\n```shell\npython setup.py bdist_wheel\n```\n\nYou can find the generated `.whl` file in the `dist` subdirectory.\n\n### 4. Install the pip package\n\n```shell\npip install dist/*.whl\n```\n\n## Supported platforms\n\n`tfx_bsl` is tested on the following 64-bit operating systems:\n\n  * macOS 10.12.6 (Sierra) or later.\n  * Ubuntu 16.04 or later.\n  * Windows 7 or later.\n\n\n## Compatible versions\n\nThe following table is the `tfx_bsl` package versions that are compatible with\neach other. This is determined by our testing framework, but other *untested*\ncombinations may also work.\n\ntfx-bsl                                                                         | apache-beam[gcp] | pyarrow  | tensorflow        | tensorflow-metadata | tensorflow-serving-api |\n------------------------------------------------------------------------------- | -----------------| ---------|-------------------|---------------------|------------------------|\n[GitHub master](https://github.com/tensorflow/tfx-bsl/blob/master/RELEASE.md)   | 2.28.0           | 2.0.0    | nightly (1.x/2.x) | 0.28.0              | 2.4.0                  |\n[0.28.0](https://github.com/tensorflow/tfx-bsl/blob/v0.28.0/RELEASE.md)         | 2.28.0           | 2.0.0    | 1.15 / 2.4        | 0.28.0              | 2.4.0                  |\n[0.27.1](https://github.com/tensorflow/tfx-bsl/blob/v0.27.1/RELEASE.md)         | 2.27.0           | 2.0.0    | 1.15 / 2.4        | 0.27.0              | 2.4.0                  |\n[0.27.0](https://github.com/tensorflow/tfx-bsl/blob/v0.27.0/RELEASE.md)         | 2.27.0           | 2.0.0    | 1.15 / 2.4        | 0.27.0              | 2.4.0                  |\n[0.26.1](https://github.com/tensorflow/tfx-bsl/blob/v0.26.1/RELEASE.md)         | 2.25.0           | 0.17.0   | 1.15 / 2.3        | 0.27.0              | 2.3.0                  |\n[0.26.0](https://github.com/tensorflow/tfx-bsl/blob/v0.26.0/RELEASE.md)         | 2.25.0           | 0.17.0   | 1.15 / 2.3        | 0.27.0              | 2.3.0                  |\n\n\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "tfx_bsl (TFX Basic Shared Libraries) contains libraries shared by many TFX (TensorFlow eXtended) libraries and components.",
    "version": "0.28.1",
    "split_keywords": [
        "tfx",
        "bsl"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "75ead958af42ce6254216430271d3fb0",
                "sha256": "0bb1b0565f09b9946bace5dcfef34d8d6462ca35b42cb4293524ddba1c46cd76"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp36-cp36m-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "75ead958af42ce6254216430271d3fb0",
            "packagetype": "bdist_wheel",
            "python_version": "cp36",
            "requires_python": ">=3.6,<4",
            "size": 2585761,
            "upload_time": "2021-02-23T17:41:42",
            "upload_time_iso_8601": "2021-02-23T17:41:42.466731Z",
            "url": "https://files.pythonhosted.org/packages/45/fc/39722b21b4696bd5a37b1a37a135beac1d8f92f287cab6fb5f140781d8f4/tfx_bsl-0.28.1-cp36-cp36m-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "677f6122d82cd477442c7db725a61ae5",
                "sha256": "e52856da7394fc7d162c463afbb0e9472c7fb08132d5fcc7277593c11c952cea"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp36-cp36m-manylinux2010_x86_64.whl",
            "has_sig": false,
            "md5_digest": "677f6122d82cd477442c7db725a61ae5",
            "packagetype": "bdist_wheel",
            "python_version": "cp36",
            "requires_python": ">=3.6,<4",
            "size": 2233764,
            "upload_time": "2021-02-23T17:38:41",
            "upload_time_iso_8601": "2021-02-23T17:38:41.086626Z",
            "url": "https://files.pythonhosted.org/packages/56/11/b0a26bffb517fb3450bff05d7ac54871e90e3bf012723f93b8b3fd9a4099/tfx_bsl-0.28.1-cp36-cp36m-manylinux2010_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ddb26daf78e33736eef97a8c8daf16d2",
                "sha256": "aa4b9d7b1b065955df0ec796794c553e568c9569b4b04f61ab7477fbb02c811e"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp36-cp36m-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "ddb26daf78e33736eef97a8c8daf16d2",
            "packagetype": "bdist_wheel",
            "python_version": "cp36",
            "requires_python": ">=3.6,<4",
            "size": 1801253,
            "upload_time": "2021-02-23T17:52:30",
            "upload_time_iso_8601": "2021-02-23T17:52:30.125136Z",
            "url": "https://files.pythonhosted.org/packages/d6/5d/2a6f2e9e6b723d4163fee589dd0f0a9cbfda4f1e0f6602f9fe68b8cb0785/tfx_bsl-0.28.1-cp36-cp36m-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "c97837cf884b22a863058dd06ff9acbc",
                "sha256": "89bd5740e9af15093cb429b33f315b322ab8488da23451ce34dd081b31adf558"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp37-cp37m-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "c97837cf884b22a863058dd06ff9acbc",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": ">=3.6,<4",
            "size": 2585967,
            "upload_time": "2021-02-23T17:42:20",
            "upload_time_iso_8601": "2021-02-23T17:42:20.028333Z",
            "url": "https://files.pythonhosted.org/packages/09/89/88a9a89ae115caf34b872169af4b27bf6855a235ed6ada4f76e13b856170/tfx_bsl-0.28.1-cp37-cp37m-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "493ed3d6fd66ec0cafd04dc70a895a29",
                "sha256": "e76a29d4cd2a8881b183881226bd23cd0e12e39e91e59d1e20a49e20748782c4"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp37-cp37m-manylinux2010_x86_64.whl",
            "has_sig": false,
            "md5_digest": "493ed3d6fd66ec0cafd04dc70a895a29",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": ">=3.6,<4",
            "size": 2233777,
            "upload_time": "2021-02-23T17:39:17",
            "upload_time_iso_8601": "2021-02-23T17:39:17.219167Z",
            "url": "https://files.pythonhosted.org/packages/19/5c/b70629871b232e0daafc3710ded3bd38ea1e85fa4c94edc44fd9fc6b8686/tfx_bsl-0.28.1-cp37-cp37m-manylinux2010_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f607bca9bbd65a10fcdacc875b09e634",
                "sha256": "cc1cd4072d1837a61a3094d535c4ead23c78d54f49bac12394e1bdded723ea3b"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp37-cp37m-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "f607bca9bbd65a10fcdacc875b09e634",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": ">=3.6,<4",
            "size": 1800809,
            "upload_time": "2021-02-23T17:52:59",
            "upload_time_iso_8601": "2021-02-23T17:52:59.229396Z",
            "url": "https://files.pythonhosted.org/packages/b1/15/ed0bd95aa369e55f79b9650fc8ca31f90719353ba1a8424436ba83a2c3ca/tfx_bsl-0.28.1-cp37-cp37m-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f59979ad25c36ce7e79fcbd534c43279",
                "sha256": "a7299c4e6448bb748190bc74f59c8591239bea74f6eff64b121db2b5f55ba40e"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp38-cp38-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "f59979ad25c36ce7e79fcbd534c43279",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": ">=3.6,<4",
            "size": 2588074,
            "upload_time": "2021-02-23T17:40:57",
            "upload_time_iso_8601": "2021-02-23T17:40:57.546788Z",
            "url": "https://files.pythonhosted.org/packages/28/da/0e525d655c558481782d667ada6ada348b79dc90a04cf059dd18dab53f85/tfx_bsl-0.28.1-cp38-cp38-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "49b516a70fa1bc11c7d1a89ca78b5f78",
                "sha256": "76572eb688d8af4f830e5991c8ad9076b1ba6a89ed1d11a86d9e06a01bcb5971"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp38-cp38-manylinux2010_x86_64.whl",
            "has_sig": false,
            "md5_digest": "49b516a70fa1bc11c7d1a89ca78b5f78",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": ">=3.6,<4",
            "size": 2235681,
            "upload_time": "2021-02-23T17:38:32",
            "upload_time_iso_8601": "2021-02-23T17:38:32.711627Z",
            "url": "https://files.pythonhosted.org/packages/4f/1e/f28658c36732272ab86c56790d6c54483087356ffcb3d123f7ea929e20fd/tfx_bsl-0.28.1-cp38-cp38-manylinux2010_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "bcdfb49f52b0bf153f7ac767f17e791d",
                "sha256": "a9d55c3ab2baa57e038d8f3fa9ebdfd81db05746f2f480314d28597c84551fd7"
            },
            "downloads": -1,
            "filename": "tfx_bsl-0.28.1-cp38-cp38-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "bcdfb49f52b0bf153f7ac767f17e791d",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": ">=3.6,<4",
            "size": 1799943,
            "upload_time": "2021-02-23T17:54:02",
            "upload_time_iso_8601": "2021-02-23T17:54:02.187904Z",
            "url": "https://files.pythonhosted.org/packages/e3/04/0294723f7419aaf193c9d1de8b46d323176e3a07eb1c0f18d41f547b6ea8/tfx_bsl-0.28.1-cp38-cp38-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-02-23 17:41:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "tfx-bsl"
}
        
Elapsed time: 0.26516s