Update README.md

README.md

@@ -1,3 +1,27 @@
----
-license: mit
----
+---
+license: mit
+base_model:
+- google-t5/t5-small
+pipeline_tag: text-generation
+tags:
+- literature
+---
+
+# compnet-renard/t5-small-literary-relation-extraction
+
+A generative relation extraction model trained on the [Despina/project_gutenberg](https://huggingface.co/datasets/Despina/project_gutenberg) dataset.
+
+Example usage:
+
+```python
+from transformers import pipeline
+
+pipeline = pipeline("text2text-generation", model="compnet-renard/t5-small-literary-relation-extraction")
+text = "Zarth Arn is Shorr Kann enemy."
+pipeline(f"extract relations: {text}")[0]["generated_text"]
+```
+```
+>>> "(Zarth Arn, enemy_of, Shorr Kann)"
+```
+
+This model is intended to be used with Renard 0.7+.