Package Exports

tfjs-npy-node

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tfjs-npy-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NumPy file parsing and serialization for TensorFlow.js

npm (scoped)

This is a fork of tfjs-npy, which adds:

New synchronous APIs
.npz parsing and serialization
Loading and saving files from disk

Note that because of support for .npz (which uses zlib for zipping), and for loading and saving files, this library is meant to be used in Node.js, not in the browser. If you want to convert to npy in the browser, consider using the original tfjs-npy.

See https://docs.scipy.org/doc/numpy/neps/npy-format.html for more information about the file format.

Installation

# Using npm
$ npm install tfjs-npy-node

# Using yarn
$ yarn add tfjs-npy-node

API

import * as tf from "@tensorflow/tfjs-core";
import { npy, npz } from "tfjs-npy-node";

////////////////
// .npy files //
////////////////

// Load a Tensor from a .npy file:
const tensor1: tf.Tensor = await npy.load("file.npy");

// Parse a Tensor from an ArrayBuffer containing the bytes of a .npy file:
const npyArrayBuffer: ArrayBuffer = getArrayBufferFromSomewhere();
const tensor2: tf.Tensor = npy.parse(npyArrayBuffer);

// Save a tensor to a .npy file:
await npy.save("file2.npy", tensor2);

// Serialize a tensor to an ArrayBuffer containing the bytes of the .npy file:
const npyArrayBuffer2: ArrayBuffer = await npy.serialize(tensor1);
const npyArrayBuffer3: ArrayBuffer = npy.serializeSync(tensor2);

////////////////
// .npz files //
////////////////

// Load a Tensor from a .npy file:
const tensors1: tf.Tensor[] = await npz.load("file.npz");

// Parse a Tensor from an ArrayBuffer containing the bytes of a .npy file:
const npzArrayBuffer: ArrayBuffer = getArrayBufferFromSomewhere();
const tensors2: tf.Tensor[] = npz.parse(npyArrayBuffer);

// Save a tensor to a .npy file:
await npz.save("file2.npz", tensors2);

// Serialize a tensor to an ArrayBuffer containing the bytes of the .npy file:
const npzArrayBuffer2: ArrayBuffer = await npz.serialize(tensors1);
const npzArrayBuffer3: ArrayBuffer = npz.serializeSync(tensors2);

Contributing

Getting started

Clone the repo, install dependencies, and run the tests:

$ git clone git@github.com:MaximeKjaer/tfjs-npy-node.git
$ cd tfjs-npy-node
$ yarn
$ yarn build
$ yarn test

Releasing a new version

If you have write access to the main branch of the repo, run:

$ yarn version