kardosdrur commited on
Commit
ff24e53
1 Parent(s): d8d3d9a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +2 -35
README.md CHANGED
@@ -60,48 +60,15 @@ model-index:
60
  ---
61
  <p align="center">
62
  <img width="200" src="https://github.com/centre-for-humanities-computing/odyCy/raw/main/docs/_static/logo_with_text_below.svg">
63
- <div align="center" style="color: #2c5882; font-weight: bold; font-size: 14px; margin-top: -18px;">
64
  A general-purpose NLP pipeline for Ancient-Greek.
65
  </div>
66
  </p>
67
- <br>
68
-
69
- ## Features
70
-
71
- - [x] Part of speech tagging
72
- - [x] Lemmatization
73
- - [x] Dependency parsing
74
- - [x] Morphological analysis
75
- - [ ] Named entity recognition (work in progress :construction:)
76
-
77
- ## Installation
78
-
79
- OdyCy models can be directly installed from huggingface:
80
-
81
- ```bash
82
- # To install the transformer-based pipeline
83
- pip install https://huggingface.co/chcaa/grc_odycy_joint_trf/resolve/main/grc_odycy_joint_trf-any-py3-none-any.whl
84
- ```
85
-
86
- ## Usage
87
 
88
  [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/centre-for-humanities-computing/odyCy/blob/main/tutorials/01_odycy_getting_started.ipynb#&offline=true&sandboxMode=true)
89
-
90
- OdyCy pipelines can be imported with spaCy.
91
-
92
- ```python
93
- import spacy
94
- # For the transformer-based pipeline
95
- nlp = spacy.load("grc_odycy_joint_trf")
96
- # For a faster and smaller (but less accurate) tok2vec-based pipeline
97
- nlp = spacy.load("grc_odycy_joint_sm")
98
- ```
99
-
100
- Pipelines can then be used as any other spaCy pipeline.
101
- ([spaCy Documentation](https://spacy.io/usage))
102
-
103
  Check out our Documentation on [Basic Usage](https://centre-for-humanities-computing.github.io/odyCy/getting_started.html).
104
 
 
105
  ## Performance
106
 
107
  odyCy achieves state of the art performance on multiple tasks on unseen test data from the Universal Dependencies Perseus treebank,
 
60
  ---
61
  <p align="center">
62
  <img width="200" src="https://github.com/centre-for-humanities-computing/odyCy/raw/main/docs/_static/logo_with_text_below.svg">
63
+ <div align="center" style="color: #2c5882; font-weight: bold; font-size: 18px; margin-top: -20px;">
64
  A general-purpose NLP pipeline for Ancient-Greek.
65
  </div>
66
  </p>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
67
 
68
  [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/centre-for-humanities-computing/odyCy/blob/main/tutorials/01_odycy_getting_started.ipynb#&offline=true&sandboxMode=true)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
  Check out our Documentation on [Basic Usage](https://centre-for-humanities-computing.github.io/odyCy/getting_started.html).
70
 
71
+
72
  ## Performance
73
 
74
  odyCy achieves state of the art performance on multiple tasks on unseen test data from the Universal Dependencies Perseus treebank,