Skip to content

[wasm] Fix documentation of setWasmPaths. #3935

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
merged 3 commits into from
Sep 16, 2020
Merged

[wasm] Fix documentation of setWasmPaths. #3935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8fd98b
fix docs
annxingyuan Sep 16, 2020
985965a
Merge branch 'master' into wasm_docs
annxingyuan Sep 16, 2020
63d29bf
save
annxingyuan Sep 16, 2020
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
17 changes: 9 additions & 8 deletions tfjs-backend-wasm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,22 +79,23 @@ backend:

```ts
import {setWasmPaths} from '@tensorflow/tfjs-backend-wasm';
// setWasmPaths accepts a `prefix` argument which indicates the path to the
// directory where your WASM binaries are located.
// setWasmPaths accepts a `prefixOrFileMap` argument which can be either a
// string or an object. If passing in a string, this indicates the path to
// the directory where your WASM binaries are located.
setWasmPaths('www.yourdomain.com/'); // or tf.wasm.setWasmPaths when using <script> tags.
tf.setBackend('wasm').then(() => {...});
```

Note that if you call `setWasmPaths` with a `prefix`, it will be used to load
each binary (SIMD-enabled, threading-enabled, etc.) However you can specify
overrides for individual WASM binaries via the second `fileMap` argument of
`setWasmPaths`. This is also helpful in case your binaries have been renamed.
Note that if you call `setWasmPaths` with a string, it will be used to load
each binary (SIMD-enabled, threading-enabled, etc.) Alternatively you can specify
overrides for individual WASM binaries via a file map object. This is also helpful
in case your binaries have been renamed.

For example:

```ts
import {setWasmPaths} from '@tensorflow/tfjs-backend-wasm';
setWasmPaths(null /* custom prefix */, {
setWasmPaths({
'tfjs-backend-wasm.wasm': 'www.yourdomain.com/renamed.wasm',
'tfjs-backend-wasm-simd.wasm': 'www.yourdomain.com/renamed-simd.wasm',
'tfjs-backend-wasm-threaded-simd.wasm': 'www.yourdomain.com/renamed-threaded-simd.wasm'
Expand All @@ -108,7 +109,7 @@ optional `usePlatformFetch` argument to `true`:
```ts
import {setWasmPath} from '@tensorflow/tfjs-backend-wasm';
const usePlatformFetch = true;
setWasmPaths(yourCustomPathPrefix, null /* file map */, usePlatformFetch);
setWasmPaths(yourCustomPathPrefix, usePlatformFetch);
tf.setBackend('wasm').then(() => {...});
```

Expand Down
3 changes: 1 addition & 2 deletions tfjs-backend-wasm/src/backend_wasm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,8 +380,7 @@ export function setWasmPath(path: string, usePlatformFetch = false): void {
* Configures the locations of the WASM binaries.
*
* ```js
* const customPrefix = null;
* setWasmPaths(customPrefix, {
* setWasmPaths({
* 'tfjs-backend-wasm.wasm': 'renamed.wasm',
* 'tfjs-backend-wasm-simd.wasm': 'renamed-simd.wasm',
* 'tfjs-backend-wasm-threaded-simd.wasm': 'renamed-threaded-simd.wasm'
Expand Down