Update README.md

README.md

@@ -2,6 +2,53 @@
 license: mit
 ---
 
-## Install
-- `python -m pip install https://huggingface.co/diyclassics/la_senter/resolve/main/la_senter-0.1.0/dist/la_senter-0.1.0.tar.gz`
- 
+# Model Card for la_senter
+
+spaCy-compatible sentence segmenter for Latin
+
+
+#  Table of Contents
+
+- [Model Details](#model-details)
+  - [Model Description](#model-description)
+- [Citation](#citation)
+- [How to Get Started with the Model](#how-to-get-started-with-the-model)
+
+
+# Model Details
+
+## Model Description
+
+<!-- Provide a longer summary of what this model is/does. -->
+spaCy-compatible sentence segmenter for Latin trained on UD treebanks
+
+- **Developed by:** Patrick J. Burns
+- **Model type:** spaCy `senter` model
+- **Language(s) (NLP):** la
+- **License:** mit
+- **Resources for more information:** 
+    - [GitHub Repo](https://github.com/diyclassics/la_senter)
+
+# Citation
+
+<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+```
+@misc{burns_la_senter_2022,
+  title = {la\_senter},  
+  version = 0.1.0, 
+  url = {https://github.com/diyclassics/la_senter},
+  abstract = {spaCy-compatible sentence segmenter for Latin},
+  urldate = {2022-12-29},
+  author = {Burns, Patrick J.},
+  year = {2022},
+}
+```
+
+# How to Get Started with the Model
+
+- Install with...
+  - `pip install https://huggingface.co/diyclassics/la_senter/resolve/main/la_senter-0.1.0/dist/la_senter-0.1.0.tar.gz`
+- Tested on python 3.10.8, spacy==3.4.2