Skip to content
Snippets Groups Projects
Commit 1d96fde9 authored by Erwan Rouchet's avatar Erwan Rouchet Committed by Bastien Abadie
Browse files

Fix typos on the element model docs

parent 5ff7c045
No related branches found
No related tags found
1 merge request!114Fix typos on the element model docs
Pipeline #169922 passed
......@@ -8,7 +8,7 @@ An `Element` is the base unit to describe any type of document. At its core, it
## Structure
To represent a document in Arkindex, we'll need to:
1. Apply a `Type` to each elements. Types are managed at projects level, and can be though of categories for elements,
1. Apply a `Type` to each element. Types are managed at projects level, and can be thought of as categories for elements,
2. Link elements together, so we can build a complex hierarchy that will represent your document: this is where we'll use the `Path`,
3. Link images to some elements; each `Element` can use a part of an `Image` by specifying the image and polygon to use.
......@@ -24,15 +24,15 @@ For example, a project with historical books could have the following simple str
In this example, we have 4 different Element types:
- **Volume** is a folder, that will be used to group several elements of type **Page**
- **Page** represent a single page of a **Volume**. These elements will be directly linked to a full image provided by the client.
- **Page** represents a single page of a **Volume**. These elements will be directly linked to a full image provided by the client.
- **Paragraph** will be created either by a human annotator, or by a Machine Learning tool.
- **Line** will generally be generated by a Machine Learning tool. In this case it could either be directly linked to a **Page** and/or a **Paragraph**.
Arkindex do not assume any structure for a Project types, the Project administrator is free to create as many types as needed. To know more about Element types, please read the [next page dedicated to Types](@/project/type.md).
Arkindex does not assume any structure for a Project's types, the Project administrator is free to create as many types as needed. To know more about Element types, please read the [next page dedicated to Types](@/project/type.md).
## Hierarchy
The hierarchy between elements is not enforced at the **Type** level (there is no graph between different Type), but at the **Element** level.
The hierarchy between elements is not enforced at the **Type** level (there is no graph between different types), but at the **Element** level.
A user can create any hierarchy between Elements using multiple Paths. A Path is simply a link between elements, linking a **Parent element** with **Children elements**. Using the example above, we can see that different instances of `Page` are all linked to a single `Volume`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment