Skip to content

Commit

Permalink
discojs*: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tharvik committed May 13, 2024
1 parent 288011f commit 6e816dc
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
7 changes: 7 additions & 0 deletions discojs-node/README.md
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).
7 changes: 7 additions & 0 deletions discojs-web/README.md
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).
24 changes: 24 additions & 0 deletions discojs/README.md
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));
```

0 comments on commit 6e816dc

Please sign in to comment.