Skip to content

Commit 943ecd3

Browse files
committed
Added: relations module documentation
Fix : relations pipe import
1 parent 9ef378d commit 943ecd3

File tree

4 files changed

+20
-6
lines changed

4 files changed

+20
-6
lines changed

docs/concepts/torch-component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ In EDS-NLP, sharing a subcomponent is simply done by sharing the object between
8282
eds.ner_crf(
8383
...,
8484
embedding=eds.transformer(
85-
model_name="bert-base-uncased",
85+
model="bert-base-uncased",
8686
window=128,
8787
stride=96,
8888
),

docs/pipes/misc/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ For instance, the date detection and normalisation pipeline falls in this catego
1616
| `eds.sections` | Section detection |
1717
| `eds.reason` | Rule-based hospitalisation reason detection |
1818
| `eds.tables` | Tables detection |
19+
| `eds.relations` | Relations extraction |
1920

2021
<!-- --8<-- [end:components] -->

docs/pipes/misc/relations.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Relations {: #edsnlp.pipes.misc.relations.factory.create_component }
2+
3+
::: edsnlp.pipes.misc.relations.factory.create_component
4+
options:
5+
heading_level: 2
6+
show_bases: false
7+
show_source: false
8+
only_class_level: true

mkdocs.yml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ nav:
7878
- pipes/misc/sections.md
7979
- pipes/misc/reason.md
8080
- pipes/misc/tables.md
81+
- pipes/misc/relations.md
8182
- Named Entity Recognition:
8283
- Overview: pipes/ner/index.md
8384
- Scores:
@@ -119,11 +120,12 @@ nav:
119120

120121
- Trainable components:
121122
- pipes/trainable/index.md
122-
- pipes/trainable/embeddings/transformer.md
123-
- pipes/trainable/embeddings/text_cnn.md
124-
- pipes/trainable/embeddings/span_pooler.md
125-
- pipes/trainable/ner.md
126-
- pipes/trainable/span-qualifier.md
123+
- 'Transformer': pipes/trainable/embeddings/transformer.md
124+
- 'Text CNN': pipes/trainable/embeddings/text_cnn.md
125+
- 'Span Pooler': pipes/trainable/embeddings/span_pooler.md
126+
- 'NER': pipes/trainable/ner.md
127+
- 'Span Classifier': pipes/trainable/span-classifier.md
128+
- 'Span Linker': pipes/trainable/span-linker.md
127129
- tokenizers.md
128130
- Data Connectors:
129131
- data/index.md
@@ -180,6 +182,9 @@ hooks:
180182
- docs/scripts/plugin.py
181183

182184
plugins:
185+
- redirects:
186+
redirect_maps:
187+
'pipes/trainable/span-qualifier.md': 'pipes/trainable/span-classifier.md'
183188
- search
184189
- minify:
185190
minify_html: true

0 commit comments

Comments
 (0)