Skip to content

Commit 52eaada

Browse files
committed
update docs to indicate the in-dev status of GenerativeRelationExtractor
1 parent 2d295ed commit 52eaada

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/pipeline.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,8 @@ to a unique character.
200200
Relation Extraction
201201
-------------------
202202

203-
- :class:`.GenerativeRelationExtractor` extracts relations between characters
204-
using a finetuned T5 model.
203+
- :class:`.GenerativeRelationExtractor` is currently in development
204+
and should not be used.
205205

206206

207207
Speaker Attribution

renard/pipeline/relation_extraction.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,13 @@ def compute_metrics(eval_preds: EvalPrediction) -> dict[str, float]:
136136

137137

138138
class GenerativeRelationExtractor(PipelineStep):
139+
"""
140+
141+
.. warning::
142+
143+
This extractor is in development and should not be used.
144+
"""
145+
139146
DEFAULT_MODEL = "compnet-renard/t5-small-literary-relation-extraction"
140147

141148
def __init__(

0 commit comments

Comments
 (0)