add docs

ArneBinder · Feb 9, 2024 · bc280af · bc280af
1 parent 989176e
commit bc280af
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/serializer/brat.py b/src/serializer/brat.py
@@ -184,7 +184,8 @@ def serialize_annotation_layers(
 
 class BratSerializer(DocumentSerializer):
     """BratSerializer serialize documents into the Brat format. It requires a "layers" parameter to
-    specify the annotation layers to serialize.
+    specify the annotation layers to serialize. For now, it supports layers containing LabeledSpan,
+    LabeledMultiSpan, and BinaryRelation annotations.
 
     If a gold_label_prefix is provided, the gold annotations are serialized with the given prefix.
     Otherwise, only the predicted annotations are serialized. A document_processor can be provided