Skip to content

Commit e94c6a9

Browse files
authored
Fix documentation typos, links (#19)
1 parent d040489 commit e94c6a9

File tree

2 files changed

+15
-20
lines changed

2 files changed

+15
-20
lines changed

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# `wasi-nn`
22

33
A proposed [WebAssembly System Interface](https://github.com/WebAssembly/WASI) API for machine
4-
learning (ML), also known as neural networks.
4+
learning (ML).
55

66
### Current Phase
77

@@ -11,8 +11,8 @@ learning (ML), also known as neural networks.
1111

1212
### Champions
1313

14-
- Andrew Brown
15-
- Mingqiu Sun
14+
- [Andrew Brown]: https://github.com/abrown
15+
- [Mingqiu Sun]: https://github.com/mingqiusun
1616

1717
### Phase 4 Advancement Criteria
1818

@@ -24,23 +24,18 @@ learning (ML), also known as neural networks.
2424
- [Goals](#goals)
2525
- [Non-goals](#non-goals)
2626
- [API walk-through](#api-walk-through)
27-
- [Use case 1](#use-case-1)
28-
- [Use case 2](#use-case-2)
2927
- [Detailed design discussion](#detailed-design-discussion)
30-
- [[Tricky design choice 1]](#tricky-design-choice-1)
31-
- [[Tricky design choice 2]](#tricky-design-choice-2)
3228
- [Considered alternatives](#considered-alternatives)
33-
- [[Alternative 1]](#alternative-1)
34-
- [[Alternative 2]](#alternative-2)
3529
- [Stakeholder Interest & Feedback](#stakeholder-interest--feedback)
3630
- [References & acknowledgements](#references--acknowledgements)
3731

3832
### Introduction
3933

40-
`wasi-nn` is a WASI API for performing ML inference. ML models are typically trained
41-
using a large data set, resulting in one or more files that describe the model's weights. The model
42-
is then used to compute an "inference," e.g., the probabilities of classifying an image as a set of
43-
tags. This API is concerned initially with inference, not training.
34+
`wasi-nn` is a WASI API for performing ML inference. Its name derives from the fact that ML models
35+
are also known as neural networks (`nn`). ML models are typically trained using a large data set,
36+
resulting in one or more files that describe the model's weights. The model is then used to compute
37+
an "inference," e.g., the probabilities of classifying an image as a set of tags. This API is
38+
concerned initially with inference, not training.
4439

4540
Why expose ML inference as a WASI API? Though the functionality of inference can be encoded into
4641
WebAssembly, there are two primary motivations for `wasi-nn`:
@@ -115,7 +110,7 @@ used to solve the given problem.
115110

116111
### Detailed design discussion
117112

118-
For the details of the API, see [wasi-nn.wit.md].
113+
For the details of the API, see [wasi-nn.wit.md](wasi-nn.wit.md).
119114

120115
<!--
121116
This section should mostly refer to the .wit.md file that specifies the API. This section is for
@@ -148,9 +143,9 @@ More "tricky" design choices fit here.
148143
There are other ways to perform ML inference from a WebAssembly program:
149144

150145
1. a user could specify a __custom host API__ for ML tasks; this is similar to the approach taken
151-
[here](TODO). The advantages and disadvantages are in line with other "spec vs. custom"
152-
trade-offs: the user can precisely tailor the API to their use case, etc., but will not be able
153-
to switch easily between implementations.
146+
[here](https://github.com/second-state/wasmedge_tensorflow_interface). The advantages and
147+
disadvantages are in line with other "spec vs. custom" trade-offs: the user can precisely tailor
148+
the API to their use case, etc., but will not be able to switch easily between implementations.
154149
2. a user could __compile a framework and/or model to WebAssembly__; this is similar to
155150
[here](https://github.com/sonos/tract) and
156151
[here](https://blog.tensorflow.org/2020/03/introducing-webassembly-backend-for-tensorflow-js.html).
@@ -173,4 +168,4 @@ Many thanks for valuable feedback and advice from:
173168

174169
- [Brian Jones](https://github.com/brianjjones)
175170
- [Radu Matei](https://github.com/radu-matei)
176-
- [Steve Schoettler](TODO)
171+
- [Steve Schoettler](https://github.com/stevelr)

wasi-nn.wit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ enum tensor-type {
3333
3434
// The tensor data.
3535
//
36-
// Initially coneived as a sparse representation, each empty cell would be filled with zeros and
36+
// Initially conceived as a sparse representation, each empty cell would be filled with zeros and
3737
// the array length must match the product of all of the dimensions and the number of bytes in the
3838
// type (e.g., a 2x2 tensor with 4-byte f32 elements would have a data array of length 16).
3939
// Naturally, this representation requires some knowledge of how to lay out data in memory--e.g.,
@@ -125,7 +125,7 @@ enum error {
125125
success,
126126
// Caller module passed an invalid argument.
127127
invalid-argument,
128-
// Invalid encocing.
128+
// Invalid encoding.
129129
invalid-encoding,
130130
// Caller module is missing a memory export.
131131
missing-memory,

0 commit comments

Comments
 (0)