You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Web applications can also benefit from such proofreading capability. This propos
9
9
10
10
11
11
1. Error Correction: Correct input text by the user
12
-
2. Error Labeling: For each correction made to each error in the input text, label the error type (e.g., spelling, punctuation, etc.)
12
+
2. Error Labeling: For each correction made to each error in the input text, label the error type (e.g. spelling, punctuation, etc.)
13
13
3. Error Explanation: Annotates each error with a plain language explanation
14
14
15
15
Note that Labeling & Explanation are independent features that can be either added or dropped.
@@ -18,14 +18,14 @@ Note that Labeling & Explanation are independent features that can be either add
18
18
19
19
Our goals are to:
20
20
21
-
* Help web developers perform real-time proofreading (e.g., of user input) on short phrases/sentences/paragraphs of freeform text.
21
+
* Help web developers perform real-time proofreading (e.g. of user input) on short phrases/sentences/paragraphs of freeform text.
22
22
* Allow web developers to build flexible proofreading UI/UX.
23
-
* Offer higher-level APIs with specific inputs and output formats that can support error labeling and explanations, abstracting away the underlying implementation (e.g., OS feature, language model, etc.).
23
+
* Offer higher-level APIs with specific inputs and output formats that can support error labeling and explanations, abstracting away the underlying implementation (e.g. OS feature, language model, etc.).
24
24
* Enable progressive enhancement, so web developers can gracefully handle varying levels of user agent support.
25
25
26
26
The following are explicit non-goals:
27
27
28
-
* Proofreading for markdown or other formats/syntaxes (e.g., not intended for JS code)
28
+
* Proofreading for markdown or other formats/syntaxes (e.g. not intended for JS code)
29
29
* Check for consistent style and formatting throughout a user-provided input
30
30
31
31
## Use cases
@@ -112,7 +112,7 @@ In the simple case, web developers should call `create()`, and handle failures g
112
112
113
113
The method will return a promise that fulfills with one of the following availability values:
114
114
“`unavailable`” means that the implementation does not support the requested options.
115
-
“`downloadable`” means that the implementation supports the requested options, but it will have to download something (e.g., a machine learning model or fine-tuning) before it can do anything.
115
+
“`downloadable`” means that the implementation supports the requested options, but it will have to download something (e.g. a machine learning model or fine-tuning) before it can do anything.
116
116
“`downloading`” means that the implementation supports the requested options, but it will have to finish an ongoing download before it can do anything.
117
117
“`available`” means that the implementation supports the requested options without requiring any new downloads.
118
118
@@ -138,7 +138,7 @@ if (supportsOurUseCase !== "unavailable") {
138
138
```
139
139
140
140
### Download progress
141
-
For cases where using the API is only possible after a download, you can monitor the download progress (e.g., in order to show your users a progress bar) using code such as the following:
141
+
For cases where using the API is only possible after a download, you can monitor the download progress (e.g. in order to show your users a progress bar) using code such as the following:
If the download fails, then `downloadprogress` events will stop being fired, and the promise returned by `create()` will be rejected with a "`NetworkError`" `DOMException`.
155
155
156
-
Note that some implementations might require multiple entities to be downloaded, e.g., a base model plus a LoRA fine-tuning. In such a case, web developers do not get the ability to monitor the individual downloads. All of them are bundled into the overall `downloadprogress` events, and the `create()` promise is not fulfilled until all downloads and loads are successful.
156
+
Note that some implementations might require multiple entities to be downloaded, e.g. a base model plus a LoRA fine-tuning. In such a case, web developers do not get the ability to monitor the individual downloads. All of them are bundled into the overall `downloadprogress` events, and the `create()` promise is not fulfilled until all downloads and loads are successful.
157
157
158
158
### Destruction and aborting
159
159
@@ -192,7 +192,7 @@ dictionary ProofreadResult {
192
192
}
193
193
```
194
194
195
-
`corrected` is the fully corrected version of the input, while `corrections` contains a list of corrections made, their locations in the original input (e.g., so web developers can create UI to highlight the error), and optionally labels/explanations.
195
+
`corrected` is the fully corrected version of the input, while `corrections` contains a list of corrections made, their locations in the original input (e.g. so web developers can create UI to highlight the error), and optionally labels/explanations.
0 commit comments