This repository provides native TensorFlow execution in backend JavaScript applications under the Node.js runtime, accelerated by the TensorFlow C binary under the hood. It provides the same API as [TensorFlow.js](https://js.tensorflow.org/api/latest/).
This repository provides native TensorFlow execution in backend JavaScript applications under the Node.js runtime,
accelerated by the TensorFlow C binary under the hood. It provides the same API as TensorFlow.js.
This package will work on Linux, Windows, and Mac platforms where TensorFlow is supported.
Installing
TensorFlow.js for Node currently supports the following platforms:
Windows / Mac OS X Requires Supported Version of Python
Windows & OSX build support for node-gyp requires that you have installed a supported version of Python. Be sure to have supported version of Python before installing @tensorflow/tfjs-node or @tensorflow/tfjs-node-gpu.
If you do not have Xcode setup on your machine, please run the following commands:
$ xcode-select --install
For Mac OS Catalina please follow this guide to install node-gyp.
After that operation completes, re-run yarn add or npm install for the @tensorflow/tfjs-node package.
You only need to include @tensorflow/tfjs-node or @tensorflow/tfjs-node-gpu in the package.json file, since those packages ship with @tensorflow/tfjs already.
Mac OS X with M1 chip
For Mac with M1 chip, tfjs-node only support arm64 build.
To install tfjs-node, you need to ensure rosetta has been turned off on your terminal app.
Start your terminal and verify following command shows arm64 as response:
uname -m
Install your node version with arm64 binary. You can verify that with following command also shows arm64:
node -e 'console.log(os.arch())'
Now you can install tfjs-node as described before.
Rebuild the package on Raspberry Pi
To use this package on Raspberry Pi, you need to rebuild the node native addon with the following command after you installed the package:
If you happen to be using a mirror for the libtensorflow binaries (default is [https://storage.googleapis.com/]), you have 3 options (in order of priority):
Set the environment variable TFJS_NODE_CDN_STORAGE. This has the same behavior as CDN_STORAGE, but introduced to prevent collisions with other npm packages that might use CDN_STORAGE.
Set the environment variable CDN_STORAGE. This option is deprecated in favor of the TFJS_NODE_ prefix version above and will be removed in a future release.
To get the most optimal TensorFlow build that can take advantage of your specific hardware (AVX512, MKL-DNN), you can build the libtensorflow library from source:
The build might take a while and will produce a bazel-bin/tensorflow/tools/lib_package/libtensorflow.tar.gz file, which should be unpacked and replace the files in deps folder of tfjs-node repo:
If you want to publish an addon library with your own libtensorflow binary, you can host the custom libtensorflow binary and optional pre-compiled node addon module on the cloud service you choose, and add a custom-binary.json file in scripts folder with the following information:
The installation scripts will automatically catch this file and use the custom libtensorflow binary and addon. If addon is not provided, the installation script will compile addon from source.