Skip to content

Commit

Permalink
improve TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
lfoppiano committed May 11, 2022
1 parent 63f8e7c commit 1f0a7d7
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@
* [Introduction](#introduction)
* [Service](#service)
+ [Overview](#overview)
+ [Keystrokes](#keystrokes)
+ [Interface features](#interface-features)
+ [Workflows](#workflows)
+ [Record reporting (flagging interface)](#record-reporting-or-flagging)
+ [Record correction](#record-correction)
+ [Training data management](#training-data-management)
+ [Keystrokes](#keystrokes)
+ [Getting started](#getting-started)
+ [API documentation](#api-documentation)
* [Process](#process)
Expand Down Expand Up @@ -67,6 +68,23 @@ The technical details of the curation interface can be found [here](docs/correct

[//]: # (![pdf-view.png](docs/images/pdf-view.png))

### Keystrokes

The interface can be managed entirely with the keyboard, which improves the efficiency of the curation work.

The table can be navigated using the arrows after having selected one row with the mouse.

The shortcuts are:

| Key | Description |
|------------|-----------------------------------------|
| n | Open the dialog for adding a new record |
| e | Edit the current record |
| arrow-up | move one record up |
| arrow-down | move to the record down |
| enter | flag/unflag the current record |


### Interface features

Here a list of the main features, please notice that they **can all be used simultaneously**.
Expand Down Expand Up @@ -156,22 +174,6 @@ The `actions` column comprises two action-buttons:
- `send` the training data to label-studio
- `remove` the training data, in case of duplicates. **In general is always better to keep the training data even if they have been sent to label-studio already**

### Keystrokes

The interface can be managed entirely with the keyboard, which improves the efficiency of the curation work.

The table can be navigated using the arrows after having selected one row with the mouse.

The shortcuts are:

| Key | Description |
|------------|-----------------------------------------|
| n | Open the dialog for adding a new record |
| e | Edit the current record |
| arrow-up | move one record up |
| arrow-down | move to the record down |
| enter | flag/unflag the current record |

### Getting started

#### Docker
Expand Down

0 comments on commit 1f0a7d7

Please sign in to comment.