Skip to content

Commit

Permalink
docs: updated reference to ner performance
Browse files Browse the repository at this point in the history
  • Loading branch information
KennethEnevoldsen committed Jun 3, 2023
1 parent 2272620 commit a88554c
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 4 deletions.
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@
# Do not execute the notebooks when building the docs (turned off by default)
nb_execution_raise_on_error = True
nb_execution_mode = "cache"
nb_execution_excludepatterns = ["tutorials/dont_run/*", "tutorials/robustness.ipynb"]
nb_execution_excludepatterns = [
"tutorials/robustness.ipynb",
"docs/performance_ner.ipynb",
]


# Automatically extract typehints when specified and place them in
Expand Down
9 changes: 9 additions & 0 deletions docs/performance.general.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ The speed of the DaNLP model is as reported by the framework (v. 0.0.11), which
However, given the model size, it can be expected to reach speeds comparable to DaCy medium.



.. add reference to: https://centre-for-humanities-computing.github.io/DaCy/performance_ner.html
.. admonition:: Want to see more performance metrics for Named entity recognition?
:class: important

If you want to see a updated comparison of the performance of the NER models, check out the `NER performance page <https://centre-for-humanities-computing.github.io/DaCy/performance_ner.html>`__.


.. admonition:: What is LAS and UAS?
:class: note

Expand Down
2 changes: 1 addition & 1 deletion docs/performance.robustness.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Named entity recognition
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The performance comparisons for robustness of NER models have all been moved to the its own section together to easily allow for comparison. Please
see the `Named Entity Recognition <https://centre-for-humanities-computing.github.io/DaCy/tutorials/dont_run_performance_ner.html>`__ section for more details.
see the `Named Entity Recognition <https://centre-for-humanities-computing.github.io/DaCy/performance_ner.html>`__ section for more details.



Expand Down
3 changes: 1 addition & 2 deletions docs/performance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ DaCy is evaulate contains performance metrics for

performance.general
performance.robustness
tutorials/dont_run/performance_ner
tutorials/robustness
tutorials/performance_ner
File renamed without changes.

0 comments on commit a88554c

Please sign in to comment.