![](../assets/docs_light_logo.png#only-light)
![](../assets/docs_dark_logo.png#only-dark)
Deep Learning in JavaScript
About
- JS-PyTorch is a Deep Learning JavaScript library, which uses the seamless PyTorch syntax.
- This means that you can use this library to train, test and deploy Neural Networks, with node.js or on a web browser.
- For access to the source code, visit The GitHub repo.
Installation
This is a node package, and can be installed with npm (Node Package Manager). It has full support of node 20.15.1, which is the latest LTS (Long-Term Support) node version, and more recent versions.
To run JS-PyTorch in the browser, first install it using npm, then link it to your HTML file:
<script src="./node_modules/js-pytorch/dist/utils.js"></script>
<script type="module">
import { torch } from './node_modules/js-pytorch/dist/js-pytorch-browser.js';
window.torch = torch;
</script>
After that, you can use JS-PyTorch freely in any script in your HTML file.
MacOS
- First, install node with the command line, as described on the node website:
# installs nvm (Node Version Manager)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
# download and install Node.js (you may need to restart the terminal)
nvm install 20
# verifies the right Node.js version is in the environment
node -v # should print `v20.15.1`
# verifies the right npm version is in the environment
npm -v # should print `10.7.0`
- Now, use npm to install Js-PyTorch locally:
# installs js-pytorch
npm install js-pytorch
# if needed, install older version of js-pytorch
nvm install js-pytorch@0.1.0
- Finally, require the package in your javascript file:
const { torch } = require("js-pytorch");
const nn = torch.nn;
const optim = torch.optim;
Linux
- First, install node with the command line, as described on the node website:
# installs nvm (Node Version Manager)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
# download and install Node.js (you may need to restart the terminal)
nvm install 20
# verifies the right Node.js version is in the environment
node -v # should print `v20.15.1`
# verifies the right npm version is in the environment
npm -v # should print `10.7.0`
- Now, use npm to install Js-PyTorch locally:
# installs js-pytorch
npm install js-pytorch
# if needed, install older version of js-pytorch
nvm install js-pytorch@0.1.0
- Finally, require the package in your javascript file:
const { torch } = require("js-pytorch");
const nn = torch.nn;
const optim = torch.optim;
Windows
-
First, download node from the prebuilt installer on the node website:
-
Now, use npm to install Js-PyTorch locally:
# installs js-pytorch
npm install js-pytorch
# if needed, install older version of js-pytorch
nvm install js-pytorch@0.1.0
Note:If this throws an error, you might need to install the latest version of Visual Studio, including the "Desktop development with C++" workload.
- Finally, require the package in your javascript file:
const { torch } = require("js-pytorch");
const nn = torch.nn;
const optim = torch.optim;
Contributing
- If you have detected a bug on the library, please file a Bug Report using a GitHub issue, and feel free to reach out to me on my LinkedIn or email.
- If you would like to see a new feature in Js-PyTorch, file a New Feature issue.
- Finally, if you would like to contribute, create a merge request to the
develop
branch. I will try to answer as soon as possible. All help is really appreciated! Here is a list of the developer tools:- Build for Distribution by running
npm run build
. CJS and ESM modules andindex.d.ts
will be output in thedist/
folder. - Check the Code with ESLint at any time, running
npm run lint
. - Run tests run
npm test
. - Improve Code Formatting with prettier, running
npm run prettier
. - Performance Benchmarks are also included in the
tests/benchmarks/
directory. Run all benchmarks withnpm run bench
and save new benchmarks withnpm run bench:update
.
- Build for Distribution by running