tfjs README

The project's README from github.com/tensorflow/tfjs. As one markdown file: README.md.

TensorFlow.js

TensorFlow.js is an open-source hardware-accelerated JavaScript library for training and deploying machine learning models.

Develop ML in the Browser
Use flexible and intuitive APIs to build models from scratch using the low-level JavaScript linear algebra library or the high-level layers API.

Develop ML in Node.js
Execute native TensorFlow with the same TensorFlow.js API under the Node.js runtime.

Run Existing models
Use TensorFlow.js model converters to run pre-existing TensorFlow models right in the browser.

Retrain Existing models
Retrain pre-existing ML models using sensor data connected to the browser or other client-side data.

About this repo

This repository contains the logic and scripts that combine several packages.

APIs:

Backends/Platforms:

If you care about bundle size, you can import those packages individually.

If you are looking for Node.js support, check out the TensorFlow.js Node directory.

Examples

Check out our examples repository and our tutorials.

Be sure to check out the gallery of all projects related to TensorFlow.js.

Pre-trained models

Be sure to also check out our models repository where we host pre-trained models on NPM.

Benchmarks

Getting started

There are two main ways to get TensorFlow.js in your JavaScript project: via script tags or by installing it from NPM and using a build tool like Parcel, WebPack, or Rollup.

via Script Tag

Add the following code to an HTML file:

<html>
  <head>
    <!-- Load TensorFlow.js -->
    <script src="https://cdn.jsdelivr.net/npm/@tensorflow/tfjs/dist/tf.min.js"> </script>


    <!-- Place your code in the script tag below. You can also use an external .js file -->
    <script>
      // Notice there is no 'import' statement. 'tf' is available on the index-page
      // because of the script tag above.

      // Define a model for linear regression.
      const model = tf.sequential();
      model.add(tf.layers.dense({units: 1, inputShape: [1]}));

      // Prepare the model for training: Specify the loss and the optimizer.
      model.compile({loss: 'meanSquaredError', optimizer: 'sgd'});

      // Generate some synthetic data for training.
      const xs = tf.tensor2d([1, 2, 3, 4], [4, 1]);
      const ys = tf.tensor2d([1, 3, 5, 7], [4, 1]);

      // Train the model using the data.
      model.fit(xs, ys).then(() => {
        // Use the model to do inference on a data point the model hasn't seen before:
        // Open the browser devtools to see the output
        model.predict(tf.tensor2d([5], [1, 1])).print();
      });
    </script>
  </head>

  <body>
  </body>
</html>

Open up that HTML file in your browser, and the code should run!

via NPM

Add TensorFlow.js to your project using yarn or npm. Note: Because we use ES2017 syntax (such as import), this workflow assumes you are using a modern browser or a bundler/transpiler to convert your code to something older browsers understand. See our examples to see how we use Parcel to build our code. However, you are free to use any build tool that you prefer.

import * as tf from '@tensorflow/tfjs';

// Define a model for linear regression.
const model = tf.sequential();
model.add(tf.layers.dense({units: 1, inputShape: [1]}));

// Prepare the model for training: Specify the loss and the optimizer.
model.compile({loss: 'meanSquaredError', optimizer: 'sgd'});

// Generate some synthetic data for training.
const xs = tf.tensor2d([1, 2, 3, 4], [4, 1]);
const ys = tf.tensor2d([1, 3, 5, 7], [4, 1]);

// Train the model using the data.
model.fit(xs, ys).then(() => {
  // Use the model to do inference on a data point the model hasn't seen before:
  model.predict(tf.tensor2d([5], [1, 1])).print();
});

See our tutorials, examples and documentation for more details.

Importing pre-trained models

We support porting pre-trained models from:

Various ops supported in different backends

Please refer below :

Find out more

TensorFlow.js is a part of the TensorFlow ecosystem. For more info:

Thanks, BrowserStack, for providing testing support.

tfjs (tensorflow/tfjs)

Searching Database…

19.1K ·GitHub
Tfjs
Что это такое?Открытая JavaScript-библиотека с аппаратным ускорением для обучения и запуска моделей машинного обучения в браузере и в Node.js.
Это библиотека, которую я подключаю к своему коду, или отдельный инструмент для запуска?Это набор JavaScript-пакетов, под которые вы пишете код: низкоуровневый Core API, Layers API в духе Keras, Data API, конвертер SavedModel, инструмент визуализации Vis прямо в браузере и загрузчики AutoML.
Как подключить её к веб-проекту?Либо добавьте тег script в HTML-файл и откройте его в браузере, либо установите пакет с NPM через yarn/npm и соберите код инструментом вроде Parcel, WebPack или Rollup.
Будет ли это работать в старых браузерах?Вариант с NPM опирается на синтаксис ES2017, например import, поэтому нужен современный браузер либо бандлер/транспайлер для поддержки старых.
Она работает только в браузере?Нет, она также запускается под Node.js через адаптер TensorFlow на C++ и в приложениях React Native через адаптер expo-gl.
Если я обучаю модель на данных пользователей в браузере, эти данные покидают устройство?Всё выполняется на стороне клиента: в README подчёркивается переобучение моделей на данных с датчиков, подключённых к браузеру, и других клиентских данных, так что данные остаются у пользователя.
Могу ли я использовать модель, которую уже обучил в TensorFlow или Keras?Да. Инструменты TensorFlow.js Converter импортируют обученные модели из TensorFlow SavedModel и Keras, так что готовую модель можно запустить в браузере, не создавая её заново с нуля.
Есть ли готовые модели, которые можно просто подключить?Да. В отдельном репозитории models собраны обученные модели TensorFlow.js, опубликованные на NPM, — их можно установить и сразу вставить в проект.
Можно ли увидеть в браузере, что происходит внутри модели?Да — пакет TensorFlow.js Vis предоставляет визуализацию моделей TensorFlow.js прямо в браузере.
Как проверить, насколько быстро моя модель работает на моём устройстве?В репозитории есть локальная страница для бенчмарков, которая собирает метрики скорости и памяти для моделей и ядер (kernels) на вашем устройстве на бэкендах CPU, WebGL и WASM, а также инструмент для тестирования нескольких устройств, включая удалённые.
What are similar projects?transformers.js, face-api.js, brain.js, cesium, gpu.js, tesseract.js, pollyjs, xterm.js
Which topics is it in?tensorflow, webgl, react-native, gpu-acceleration, neural-network, wasm, javascript-library, inference, browser, benchmark, web-development, deep-learning
Creator
tensorflow
Size
170.2 MB
Stars
19.1K
Updated
CommitApr 06Releasetfjs-v4.22.0Oct 21
Age
8y
Commits · 90 Days