TensorFlow I/O

Ta strona została przetłumaczona przez Cloud Translation API.

Rozwój

Dokument zawiera informacje niezbędne do skonfigurowania środowiska programistycznego i zbudowania pakietu tensorflow-io ze źródeł na różnych platformach. Po zakończeniu konfiguracji zapoznaj się z STYLE_GUIDE, aby uzyskać wskazówki dotyczące dodawania nowych operacji.

Konfiguracja IDE

Instrukcje dotyczące konfigurowania kodu Visual Studio do tworzenia operacji we/wy TensorFlow można znaleźć w tym dokumencie .

Szarpie

Kod wejścia/wyjścia TensorFlow jest zgodny z Bazel Buildifier, Clang Format, Black i Pyupgrade. Użyj następującego polecenia, aby sprawdzić kod źródłowy i zidentyfikować problemy z lintami:

# Install Bazel version specified in .bazelversion
$ curl -OL https://github.com/bazelbuild/bazel/releases/download/$(cat .bazelversion)/bazel-$(cat .bazelversion)-installer-darwin-x86_64.sh
$ sudo bash -x -e bazel-$(cat .bazelversion)-installer-darwin-x86_64.sh
$ bazel run //tools/lint:check

W przypadku Bazel Buildifier i Clang Format następujące polecenie automatycznie zidentyfikuje i naprawi wszelkie błędy lint:

$ bazel run //tools/lint:lint

Alternatywnie, jeśli chcesz tylko sprawdzić lintowanie przy użyciu pojedynczych lintersów, możesz selektywnie przekazać black , pyupgrade , bazel lub clang do powyższych poleceń.

Na przykład sprawdzenie black w przypadku czerni można wykonać za pomocą:

$ bazel run //tools/lint:check -- black

Naprawę lint za pomocą Bazel Buildifier i formatu Clang można wykonać za pomocą:

$ bazel run //tools/lint:lint -- bazel clang

Sprawdzanie lint przy użyciu black i pyupgrade dla pojedynczego pliku Pythona można wykonać za pomocą:

$ bazel run //tools/lint:check -- black pyupgrade -- tensorflow_io/python/ops/version_ops.py

Lint napraw indywidualny plik Pythona za pomocą koloru czarnego i pyupgrade, używając:

$ bazel run //tools/lint:lint -- black pyupgrade --  tensorflow_io/python/ops/version_ops.py

Pyton

macOS

W systemie macOS Catalina 10.15.7 możliwe jest zbudowanie tensorflow-io z dostarczonym przez system Pythonem 3.8.2. Do tego potrzebny jest zarówno tensorflow , jak i bazel .

#!/usr/bin/env bash

# Disable arm64 build by specifying only x86_64 arch.
# Only needed for macOS's system default python 3.8.2 on macOS 10.15.7
export ARCHFLAGS="-arch x86_64"

# Use following command to check if Xcode is correctly installed:
xcodebuild -version

# Show macOS's default python3
python3 --version

# Install Bazel version specified in .bazelversion
curl -OL https://github.com/bazelbuild/bazel/releases/download/$(cat .bazelversion)/bazel-$(cat .bazelversion)-installer-darwin-x86_64.sh
sudo bash -x -e bazel-$(cat .bazelversion)-installer-darwin-x86_64.sh

# Install tensorflow and configure bazel
sudo ./configure.sh

# Add any optimization on bazel command, e.g., --compilation_mode=opt,
#   --copt=-msse4.2, --remote_cache=, etc.
# export BAZEL_OPTIMIZATION=

# Build shared libraries
bazel build -s --verbose_failures $BAZEL_OPTIMIZATION //tensorflow_io/... //tensorflow_io_gcs_filesystem/...

# Once build is complete, shared libraries will be available in
# `bazel-bin/tensorflow_io/core`, `bazel-bin/tensorflow_io/python/ops` and
# it is possible to run tests with `pytest`, e.g.:
sudo python3 -m pip install pytest
TFIO_DATAPATH=bazel-bin python3 -m pytest -s -v tests/test_serialization.py

Rozwiązywanie problemów

Jeśli Xcode jest zainstalowany, ale $ xcodebuild -version nie wyświetla oczekiwanych wyników, może być konieczne włączenie wiersza poleceń Xcode za pomocą polecenia:

$ xcode-select -s /Applications/Xcode.app/Contents/Developer .

Aby zmiany zaczęły obowiązywać, może być konieczne ponowne uruchomienie terminala.

Przykładowe wyjście:

$ xcodebuild -version
Xcode 12.2
Build version 12B45b

Linuksa

Rozwój tensorflow-io w systemie Linux jest podobny do macOS. Wymagane pakiety to gcc, g++, git, bazel i python 3. Mogą jednak być wymagane nowsze wersje gcc lub python, inne niż wersje instalowane domyślnie w systemie.

Ubuntu 20.04

Ubuntu 20.04 wymaga gcc/g++, git i python 3. Poniższe instrukcje zainstalują zależności i zbudują biblioteki współdzielone w Ubuntu 20.04:

#!/usr/bin/env bash

# Install gcc/g++, git, unzip/curl (for bazel), and python3
sudo apt-get -y -qq update
sudo apt-get -y -qq install gcc g++ git unzip curl python3-pip

# Install Bazel version specified in .bazelversion
curl -sSOL <a href="https://github.com/bazelbuild/bazel/releases/download/">https://github.com/bazelbuild/bazel/releases/download/</a>\\((cat .bazelversion)/bazel-\\)(cat .bazelversion)-installer-linux-x86_64.sh
sudo bash -x -e bazel-$(cat .bazelversion)-installer-linux-x86_64.sh

# Upgrade pip
sudo python3 -m pip install -U pip

# Install tensorflow and configure bazel
sudo ./configure.sh

# Alias python3 to python, needed by bazel
sudo ln -s /usr/bin/python3 /usr/bin/python

# Add any optimization on bazel command, e.g., --compilation_mode=opt,
#   --copt=-msse4.2, --remote_cache=, etc.
# export BAZEL_OPTIMIZATION=

# Build shared libraries
bazel build -s --verbose_failures $BAZEL_OPTIMIZATION //tensorflow_io/... //tensorflow_io_gcs_filesystem/...

# Once build is complete, shared libraries will be available in
# `bazel-bin/tensorflow_io/core`, `bazel-bin/tensorflow_io/python/ops` and
# it is possible to run tests with `pytest`, e.g.:
sudo python3 -m pip install pytest
TFIO_DATAPATH=bazel-bin python3 -m pytest -s -v tests/test_serialization.py

CentOS 8

Kroki tworzenia bibliotek współdzielonych dla CentOS 8 są podobne do powyższych kroków w Ubuntu 20.04, z tą różnicą, że

sudo yum install -y python3 python3-devel gcc gcc-c++ git unzip which make

zamiast tego należy go użyć do zainstalowania gcc/g++, git, unzip/what (dla Bazel) i python3.

CentOS 7

W CentOS 7 domyślna wersja Pythona i GCC jest zbyt stara, aby można było zbudować biblioteki współdzielone tensorflow-io (.so). Zamiast tego należy użyć gcc dostarczonego przez zestaw narzędzi dla programistów i rh-python36. Ponadto biblioteka libstdc++ musi być połączona statycznie, aby uniknąć rozbieżności między biblioteką libstdc++ zainstalowaną na CentOS a nowszą wersją gcc autorstwa devtoolset.

Co więcej, do Bazela należy przekazać specjalną flagę --//tensorflow_io/core:static_build aby uniknąć duplikacji symboli w statycznie połączonych bibliotekach dla wtyczek systemu plików.

Następujące czynności zainstalują bazel, devtoolset-9, rh-python36 i zbudują biblioteki współdzielone:

#!/usr/bin/env bash

# Install centos-release-scl, then install gcc/g++ (devtoolset), git, and python 3
sudo yum install -y centos-release-scl
sudo yum install -y devtoolset-9 git rh-python36 make

# Install Bazel version specified in .bazelversion
curl -sSOL <a href="https://github.com/bazelbuild/bazel/releases/download/">https://github.com/bazelbuild/bazel/releases/download/</a>\\((cat .bazelversion)/bazel-\\)(cat .bazelversion)-installer-linux-x86_64.sh
sudo bash -x -e bazel-$(cat .bazelversion)-installer-linux-x86_64.sh

# Upgrade pip
scl enable rh-python36 devtoolset-9 \
    'python3 -m pip install -U pip'

# Install tensorflow and configure bazel with rh-python36
scl enable rh-python36 devtoolset-9 \
    './configure.sh'

# Add any optimization on bazel command, e.g., --compilation_mode=opt,
#   --copt=-msse4.2, --remote_cache=, etc.
# export BAZEL_OPTIMIZATION=

# Build shared libraries, notice the passing of --//tensorflow_io/core:static_build
BAZEL_LINKOPTS="-static-libstdc++ -static-libgcc" BAZEL_LINKLIBS="-lm -l%:libstdc++.a" \
  scl enable rh-python36 devtoolset-9 \
    'bazel build -s --verbose_failures $BAZEL_OPTIMIZATION --//tensorflow_io/core:static_build //tensorflow_io/...'

# Once build is complete, shared libraries will be available in
# `bazel-bin/tensorflow_io/core`, `bazel-bin/tensorflow_io/python/ops` and
# it is possible to run tests with `pytest`, e.g.:
scl enable rh-python36 devtoolset-9 \
    'python3 -m pip install pytest'

TFIO_DATAPATH=bazel-bin \
  scl enable rh-python36 devtoolset-9 \
    'python3 -m pytest -s -v tests/test_serialization.py'

Doker

W przypadku programowania w języku Python można użyć referencyjnego pliku Dockerfile w celu zbudowania pakietu we/wy TensorFlow ( tensorflow-io ) ze źródła. Dodatkowo można również użyć gotowych obrazów deweloperskich:

# Pull (if necessary) and start the devel container
\\( docker run -it --rm --name tfio-dev --net=host -v \\){PWD}:/v -w /v tfsigio/tfio:latest-devel bash

# Inside the docker container, ./configure.sh will install TensorFlow or use existing install
(tfio-dev) root@docker-desktop:/v$ ./configure.sh

# Clean up exisiting bazel build's (if any)
(tfio-dev) root@docker-desktop:/v$ rm -rf bazel-*

# Build TensorFlow I/O C++. For compilation optimization flags, the default (-march=native)
# optimizes the generated code for your machine's CPU type.
# Reference: <a href="https://www.tensorflow.orginstall/source#configuration_options">https://www.tensorflow.orginstall/source#configuration_options</a>).

# NOTE: Based on the available resources, please change the number of job workers to:
# -j 4/8/16 to prevent bazel server terminations and resource oriented build errors.

(tfio-dev) root@docker-desktop:/v$ bazel build -j 8 --copt=-msse4.2 --copt=-mavx --compilation_mode=opt --verbose_failures --test_output=errors --crosstool_top=//third_party/toolchains/gcc7_manylinux2010:toolchain //tensorflow_io/... //tensorflow_io_gcs_filesystem/...


# Run tests with PyTest, note: some tests require launching additional containers to run (see below)
(tfio-dev) root@docker-desktop:/v$ pytest -s -v tests/
# Build the TensorFlow I/O package
(tfio-dev) root@docker-desktop:/v$ python setup.py bdist_wheel

Po pomyślnym zakończeniu kompilacji zostanie wygenerowany plik pakietu dist/tensorflow_io-*.whl

Koła Pythona

Możliwe jest zbudowanie kół Pythona po zakończeniu kompilacji Bazela za pomocą następującego polecenia:

$ python setup.py bdist_wheel --data bazel-bin

Plik .whl będzie dostępny w katalogu dist. Należy zauważyć, że do katalogu binarnego bazel bazel-bin należy przekazać argumenty --data , aby plik setup.py mógł zlokalizować niezbędne obiekty współdzielone, ponieważ bazel-bin znajduje się poza katalogiem pakietu tensorflow_io .

Alternatywnie instalację źródłową można wykonać za pomocą:

$ TFIO_DATAPATH=bazel-bin python -m pip install .

z TFIO_DATAPATH=bazel-bin przekazany z tego samego powodu.

Uwaga: instalacja z -e różni się od powyższej. The

$ TFIO_DATAPATH=bazel-bin python -m pip install -e .

nie zainstaluje automatycznie udostępnionego obiektu nawet z TFIO_DATAPATH=bazel-bin . Zamiast tego należy przekazać TFIO_DATAPATH=bazel-bin przy każdym uruchomieniu programu po instalacji:

$ TFIO_DATAPATH=bazel-bin python

>>> import tensorflow_io as tfio
>>> ...

Testowanie

Niektóre testy wymagają przed uruchomieniem uruchomienia kontenera testowego lub uruchomienia lokalnej instancji powiązanego narzędzia. Na przykład, aby uruchomić testy związane z kafką, które uruchomią lokalną instancję kafki, zookeepera i rejestru schematów, użyj:

# Start the local instances of kafka, zookeeper and schema-registry
$ bash -x -e tests/test_kafka/kafka_test.sh

# Run the tests
$ TFIO_DATAPATH=bazel-bin pytest -s -vv tests/test_kafka.py

Testowanie Datasets powiązane z narzędziami takimi jak Elasticsearch czy MongoDB wymagają obecności okna dokowanego w systemie. W takich scenariuszach użyj:

# Start elasticsearch within docker container
$ bash tests/test_elasticsearch/elasticsearch_test.sh start

# Run the tests
$ TFIO_DATAPATH=bazel-bin pytest -s -vv tests/test_elasticsearch.py

# Stop and remove the container
$ bash tests/test_elasticsearch/elasticsearch_test.sh stop

Dodatkowo testowanie niektórych funkcji tensorflow-io nie wymaga uruchamiania żadnych dodatkowych narzędzi, ponieważ dane znajdują się w samym katalogu tests . Na przykład, aby uruchomić testy związane ze zbiorem danych dotyczących parquet , użyj:

# Just run the test
$ TFIO_DATAPATH=bazel-bin pytest -s -vv tests/test_parquet.py

R

Udostępniamy tutaj referencyjny plik Dockerfile, dzięki czemu możesz używać pakietu R bezpośrednio do testowania. Możesz go zbudować poprzez:

$ docker build -t tfio-r-dev -f R-package/scripts/Dockerfile .

Wewnątrz kontenera możesz rozpocząć sesję R, utworzyć instancję SequenceFileDataset na podstawie przykładowego Hadoop SequenceFile string.seq , a następnie użyć dowolnych funkcji transformacji dostarczonych przez pakiet tfdatasets w zestawie danych, jak poniżej:

library(tfio)
dataset <- sequence_file_dataset("R-package/tests/testthat/testdata/string.seq") %>%
    dataset_repeat(2)

sess <- tf$Session()
iterator <- make_iterator_one_shot(dataset)
next_batch <- iterator_get_next(iterator)

until_out_of_range({
  batch <- sess$run(next_batch)
  print(batch)
})