-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# @epfml/discojs-node | ||
|
||
Decentralized & federated privacy-preserving ML training in TypeScript. | ||
|
||
This is the node-specific library of the Disco.js project, | ||
offering some helpers. | ||
You probably want to also use [`discojs`](../discojs). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# @epfml/discojs-web | ||
|
||
Decentralized & federated privacy-preserving ML training in TypeScript. | ||
|
||
This is the web-specific library of the Disco.js project, | ||
offering some helpers. | ||
You probably want to also use [`discojs`](../discojs). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# @epfml/discojs | ||
|
||
Decentralized & federated privacy-preserving ML training in TypeScript. | ||
|
||
This is the core library of the Disco.js project. | ||
|
||
It is platform-agnostic, and has two companions library: | ||
- [`discojs-node`](../discojs-node) for Node.js | ||
- [`discojs-web`](../discojs-web) for web browsers | ||
|
||
The easiest way to start using it is through the `Disco` object. | ||
Create your own `Task` or load one from our `default_tasks`, | ||
setup the `Dataset` you want, and train with it. | ||
|
||
```ts | ||
import { Disco } from '@epfml/discojs' | ||
|
||
const url = ...; // url to a Disco.js server | ||
const dataset = ...; | ||
const task = ...; | ||
|
||
const disco = new Disco(task, { url }) | ||
for await (const _ of disco.fit(dataset)); | ||
``` |