Skip to content

more updates to readme #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dcrescim merged 1 commit into from
May 21, 2022
Merged

more updates to readme #229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Documentation site: [www.scikitjs.org](https://www.scikitjs.org)
For use with modern bundlers in a frontend application, simply

```bash
npm i @tensorflow/tfjs
npm i scikitjs
npm i @tensorflow/tfjs scikitjs
```

We depend on the tensorflow library in order to make our calculations fast, but we don't ship it in our bundle.
Expand All @@ -40,16 +39,24 @@ This allows us to build a library that can be used in Deno, Node, and the browse
For Node.js users who wish to bind to the Tensorflow C++ library, simply import the tensorflow C++ version, and use that as the tf library

```bash
npm i @tensorflow/tfjs-node
npm i scikitjs
npm i @tensorflow/tfjs-node scikitjs
```

```js
const tf = require('@tensorflow/tfjs-node')
const sk = require('scikitjs')
sk.setBackend(tf)
```

Note: If you have ESM enabled (by setting type="module" in your package.json), then you can consume this libary with import / export, like in the following code block.

```js
import * as tf from '@tensorflow/tfjs-node'
import * as sk from 'scikitjs'
sk.setBackend(tf)
```


### Script src

For those that wish to use script src tags, simply
Expand All @@ -68,7 +75,7 @@ For those that wish to use script src tags, simply
## Simple Example

```js
import * as tf from '@tensorflow/tfjs-node'
import * as tf from '@tensorflow/tfjs'
import { setBackend, LinearRegression } from 'scikitjs'
setBackend(tf)

Expand Down Expand Up @@ -128,7 +135,7 @@ Turns into
#### JavaScript

```js
import * as tf from '@tensorflow/tfjs-node'
import * as tf from '@tensorflow/tfjs'
import { setBackend, LinearRegression } from 'scikitjs'
setBackend(tf)

Expand Down Expand Up @@ -160,7 +167,7 @@ Turns into
#### JavaScript

```js
import * as tf from '@tensorflow/tfjs-node'
import * as tf from '@tensorflow/tfjs'
import { setBackend, LinearRegression } from 'scikitjs'
setBackend(tf)

Expand Down Expand Up @@ -197,7 +204,7 @@ Turns into
#### JavaScript

```js
import * as tf from '@tensorflow/tfjs-node'
import * as tf from '@tensorflow/tfjs'
import { setBackend, LogisticRegression } from 'scikitjs'
setBackend(tf)

Expand Down