Introduction to Syft.js
Syft.js is a microlibrary built on top of TensorFlow.js, allowing for a socket connection with any running PySyft instance.
PySyft acts as the parent node, instructing child nodes (Syft.js instances running in a website on users' browsers) of what tensors to add to a list, remove from a list, and operate against.
If you're using a package manage like NPM:
npm install --save syft.js @tensorflow/tfjs
Or if Yarn is your cup of tea:
yarn add syft.js @tensorflow/tfjs
When using a package manager, TensorFlow.js will be automatically installed.
If you're not using a package manager, you can also include Syft.js within a
<script src="https://cdn.jsdelivr.net/npm/@email@example.com/dist/tf.min.js"></script> <script src="https://unpkg.com/syft.js@latest"></script>
For integration into your client-side application, please check out our guide.
For further API documentation, please check that out here.
- Fork and clone
- Do your work.
- Push to your clone
- Submit a PR to openmined/syft.js
We're accepting PR's for testing at the moment to improve our overall code coverage. In terms of core functionality, we're considering the current version of Syft.js feature complete until a further roadmap is designated.