2022-04-05 07:08:02 +00:00
|
|
|
from typing import Any, Dict, List, Optional, Tuple, Union
|
2018-12-27 13:46:02 +00:00
|
|
|
import uuid
|
2022-03-16 17:14:34 +00:00
|
|
|
import itertools
|
💫 Port master changes over to develop (#2979)
* Create aryaprabhudesai.md (#2681)
* Update _install.jade (#2688)
Typo fix: "models" -> "model"
* Add FAC to spacy.explain (resolves #2706)
* Remove docstrings for deprecated arguments (see #2703)
* When calling getoption() in conftest.py, pass a default option (#2709)
* When calling getoption() in conftest.py, pass a default option
This is necessary to allow testing an installed spacy by running:
pytest --pyargs spacy
* Add contributor agreement
* update bengali token rules for hyphen and digits (#2731)
* Less norm computations in token similarity (#2730)
* Less norm computations in token similarity
* Contributor agreement
* Remove ')' for clarity (#2737)
Sorry, don't mean to be nitpicky, I just noticed this when going through the CLI and thought it was a quick fix. That said, if this was intention than please let me know.
* added contributor agreement for mbkupfer (#2738)
* Basic support for Telugu language (#2751)
* Lex _attrs for polish language (#2750)
* Signed spaCy contributor agreement
* Added polish version of english lex_attrs
* Introduces a bulk merge function, in order to solve issue #653 (#2696)
* Fix comment
* Introduce bulk merge to increase performance on many span merges
* Sign contributor agreement
* Implement pull request suggestions
* Describe converters more explicitly (see #2643)
* Add multi-threading note to Language.pipe (resolves #2582) [ci skip]
* Fix formatting
* Fix dependency scheme docs (closes #2705) [ci skip]
* Don't set stop word in example (closes #2657) [ci skip]
* Add words to portuguese language _num_words (#2759)
* Add words to portuguese language _num_words
* Add words to portuguese language _num_words
* Update Indonesian model (#2752)
* adding e-KTP in tokenizer exceptions list
* add exception token
* removing lines with containing space as it won't matter since we use .split() method in the end, added new tokens in exception
* add tokenizer exceptions list
* combining base_norms with norm_exceptions
* adding norm_exception
* fix double key in lemmatizer
* remove unused import on punctuation.py
* reformat stop_words to reduce number of lines, improve readibility
* updating tokenizer exception
* implement is_currency for lang/id
* adding orth_first_upper in tokenizer_exceptions
* update the norm_exception list
* remove bunch of abbreviations
* adding contributors file
* Fixed spaCy+Keras example (#2763)
* bug fixes in keras example
* created contributor agreement
* Adding French hyphenated first name (#2786)
* Fix typo (closes #2784)
* Fix typo (#2795) [ci skip]
Fixed typo on line 6 "regcognizer --> recognizer"
* Adding basic support for Sinhala language. (#2788)
* adding Sinhala language package, stop words, examples and lex_attrs.
* Adding contributor agreement
* Updating contributor agreement
* Also include lowercase norm exceptions
* Fix error (#2802)
* Fix error
ValueError: cannot resize an array that references or is referenced
by another array in this way. Use the resize function
* added spaCy Contributor Agreement
* Add charlax's contributor agreement (#2805)
* agreement of contributor, may I introduce a tiny pl languge contribution (#2799)
* Contributors agreement
* Contributors agreement
* Contributors agreement
* Add jupyter=True to displacy.render in documentation (#2806)
* Revert "Also include lowercase norm exceptions"
This reverts commit 70f4e8adf37cfcfab60be2b97d6deae949b30e9e.
* Remove deprecated encoding argument to msgpack
* Set up dependency tree pattern matching skeleton (#2732)
* Fix bug when too many entity types. Fixes #2800
* Fix Python 2 test failure
* Require older msgpack-numpy
* Restore encoding arg on msgpack-numpy
* Try to fix version pin for msgpack-numpy
* Update Portuguese Language (#2790)
* Add words to portuguese language _num_words
* Add words to portuguese language _num_words
* Portuguese - Add/remove stopwords, fix tokenizer, add currency symbols
* Extended punctuation and norm_exceptions in the Portuguese language
* Correct error in spacy universe docs concerning spacy-lookup (#2814)
* Update Keras Example for (Parikh et al, 2016) implementation (#2803)
* bug fixes in keras example
* created contributor agreement
* baseline for Parikh model
* initial version of parikh 2016 implemented
* tested asymmetric models
* fixed grevious error in normalization
* use standard SNLI test file
* begin to rework parikh example
* initial version of running example
* start to document the new version
* start to document the new version
* Update Decompositional Attention.ipynb
* fixed calls to similarity
* updated the README
* import sys package duh
* simplified indexing on mapping word to IDs
* stupid python indent error
* added code from https://github.com/tensorflow/tensorflow/issues/3388 for tf bug workaround
* Fix typo (closes #2815) [ci skip]
* Update regex version dependency
* Set version to 2.0.13.dev3
* Skip seemingly problematic test
* Remove problematic test
* Try previous version of regex
* Revert "Remove problematic test"
This reverts commit bdebbef45552d698d390aa430b527ee27830f11b.
* Unskip test
* Try older version of regex
* 💫 Update training examples and use minibatching (#2830)
<!--- Provide a general summary of your changes in the title. -->
## Description
Update the training examples in `/examples/training` to show usage of spaCy's `minibatch` and `compounding` helpers ([see here](https://spacy.io/usage/training#tips-batch-size) for details). The lack of batching in the examples has caused some confusion in the past, especially for beginners who would copy-paste the examples, update them with large training sets and experienced slow and unsatisfying results.
### Types of change
enhancements
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Visual C++ link updated (#2842) (closes #2841) [ci skip]
* New landing page
* Add contribution agreement
* Correcting lang/ru/examples.py (#2845)
* Correct some grammatical inaccuracies in lang\ru\examples.py; filled Contributor Agreement
* Correct some grammatical inaccuracies in lang\ru\examples.py
* Move contributor agreement to separate file
* Set version to 2.0.13.dev4
* Add Persian(Farsi) language support (#2797)
* Also include lowercase norm exceptions
* Remove in favour of https://github.com/explosion/spaCy/graphs/contributors
* Rule-based French Lemmatizer (#2818)
<!--- Provide a general summary of your changes in the title. -->
## Description
<!--- Use this section to describe your changes. If your changes required
testing, include information about the testing environment and the tests you
ran. If your test fixes a bug reported in an issue, don't forget to include the
issue number. If your PR is still a work in progress, that's totally fine – just
include a note to let us know. -->
Add a rule-based French Lemmatizer following the english one and the excellent PR for [greek language optimizations](https://github.com/explosion/spaCy/pull/2558) to adapt the Lemmatizer class.
### Types of change
<!-- What type of change does your PR cover? Is it a bug fix, an enhancement
or new feature, or a change to the documentation? -->
- Lemma dictionary used can be found [here](http://infolingu.univ-mlv.fr/DonneesLinguistiques/Dictionnaires/telechargement.html), I used the XML version.
- Add several files containing exhaustive list of words for each part of speech
- Add some lemma rules
- Add POS that are not checked in the standard Lemmatizer, i.e PRON, DET, ADV and AUX
- Modify the Lemmatizer class to check in lookup table as a last resort if POS not mentionned
- Modify the lemmatize function to check in lookup table as a last resort
- Init files are updated so the model can support all the functionalities mentioned above
- Add words to tokenizer_exceptions_list.py in respect to regex used in tokenizer_exceptions.py
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [X] I have submitted the spaCy Contributor Agreement.
- [X] I ran the tests, and all new and existing tests passed.
- [X] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Set version to 2.0.13
* Fix formatting and consistency
* Update docs for new version [ci skip]
* Increment version [ci skip]
* Add info on wheels [ci skip]
* Adding "This is a sentence" example to Sinhala (#2846)
* Add wheels badge
* Update badge [ci skip]
* Update README.rst [ci skip]
* Update murmurhash pin
* Increment version to 2.0.14.dev0
* Update GPU docs for v2.0.14
* Add wheel to setup_requires
* Import prefer_gpu and require_gpu functions from Thinc
* Add tests for prefer_gpu() and require_gpu()
* Update requirements and setup.py
* Workaround bug in thinc require_gpu
* Set version to v2.0.14
* Update push-tag script
* Unhack prefer_gpu
* Require thinc 6.10.6
* Update prefer_gpu and require_gpu docs [ci skip]
* Fix specifiers for GPU
* Set version to 2.0.14.dev1
* Set version to 2.0.14
* Update Thinc version pin
* Increment version
* Fix msgpack-numpy version pin
* Increment version
* Update version to 2.0.16
* Update version [ci skip]
* Redundant ')' in the Stop words' example (#2856)
<!--- Provide a general summary of your changes in the title. -->
## Description
<!--- Use this section to describe your changes. If your changes required
testing, include information about the testing environment and the tests you
ran. If your test fixes a bug reported in an issue, don't forget to include the
issue number. If your PR is still a work in progress, that's totally fine – just
include a note to let us know. -->
### Types of change
<!-- What type of change does your PR cover? Is it a bug fix, an enhancement
or new feature, or a change to the documentation? -->
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [ ] I have submitted the spaCy Contributor Agreement.
- [ ] I ran the tests, and all new and existing tests passed.
- [ ] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Documentation improvement regarding joblib and SO (#2867)
Some documentation improvements
## Description
1. Fixed the dead URL to joblib
2. Fixed Stack Overflow brand name (with space)
### Types of change
Documentation
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
* raise error when setting overlapping entities as doc.ents (#2880)
* Fix out-of-bounds access in NER training
The helper method state.B(1) gets the index of the first token of the
buffer, or -1 if no such token exists. Normally this is safe because we
pass this to functions like state.safe_get(), which returns an empty
token. Here we used it directly as an array index, which is not okay!
This error may have been the cause of out-of-bounds access errors during
training. Similar errors may still be around, so much be hunted down.
Hunting this one down took a long time...I printed out values across
training runs and diffed, looking for points of divergence between
runs, when no randomness should be allowed.
* Change PyThaiNLP Url (#2876)
* Fix missing comma
* Add example showing a fix-up rule for space entities
* Set version to 2.0.17.dev0
* Update regex version
* Revert "Update regex version"
This reverts commit 62358dd867d15bc6a475942dff34effba69dd70a.
* Try setting older regex version, to align with conda
* Set version to 2.0.17
* Add spacy-js to universe [ci-skip]
* Add spacy-raspberry to universe (closes #2889)
* Add script to validate universe json [ci skip]
* Removed space in docs + added contributor indo (#2909)
* - removed unneeded space in documentation
* - added contributor info
* Allow input text of length up to max_length, inclusive (#2922)
* Include universe spec for spacy-wordnet component (#2919)
* feat: include universe spec for spacy-wordnet component
* chore: include spaCy contributor agreement
* Minor formatting changes [ci skip]
* Fix image [ci skip]
Twitter URL doesn't work on live site
* Check if the word is in one of the regular lists specific to each POS (#2886)
* 💫 Create random IDs for SVGs to prevent ID clashes (#2927)
Resolves #2924.
## Description
Fixes problem where multiple visualizations in Jupyter notebooks would have clashing arc IDs, resulting in weirdly positioned arc labels. Generating a random ID prefix so even identical parses won't receive the same IDs for consistency (even if effect of ID clash isn't noticable here.)
### Types of change
bug fix
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Fix typo [ci skip]
* fixes symbolic link on py3 and windows (#2949)
* fixes symbolic link on py3 and windows
during setup of spacy using command
python -m spacy link en_core_web_sm en
closes #2948
* Update spacy/compat.py
Co-Authored-By: cicorias <cicorias@users.noreply.github.com>
* Fix formatting
* Update universe [ci skip]
* Catalan Language Support (#2940)
* Catalan language Support
* Ddding Catalan to documentation
* Sort languages alphabetically [ci skip]
* Update tests for pytest 4.x (#2965)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Replace marks in params for pytest 4.0 compat ([see here](https://docs.pytest.org/en/latest/deprecations.html#marks-in-pytest-mark-parametrize))
- [x] Un-xfail passing tests (some fixes in a recent update resolved a bunch of issues, but tests were apparently never updated here)
### Types of change
<!-- What type of change does your PR cover? Is it a bug fix, an enhancement
or new feature, or a change to the documentation? -->
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Fix regex pin to harmonize with conda (#2964)
* Update README.rst
* Fix bug where Vocab.prune_vector did not use 'batch_size' (#2977)
Fixes #2976
* Fix typo
* Fix typo
* Remove duplicate file
* Require thinc 7.0.0.dev2
Fixes bug in gpu_ops that would use cupy instead of numpy on CPU
* Add missing import
* Fix error IDs
* Fix tests
2018-11-29 15:30:29 +00:00
|
|
|
|
2019-08-20 13:51:37 +00:00
|
|
|
from ..errors import Errors
|
2022-03-16 17:14:34 +00:00
|
|
|
from ..util import escape_html, minify_html, registry
|
|
|
|
from .templates import TPL_DEP_ARCS, TPL_DEP_SVG, TPL_DEP_WORDS
|
|
|
|
from .templates import TPL_DEP_WORDS_LEMMA, TPL_ENT, TPL_ENT_RTL, TPL_ENTS
|
|
|
|
from .templates import TPL_FIGURE, TPL_KB_LINK, TPL_PAGE, TPL_SPAN
|
|
|
|
from .templates import TPL_SPAN_RTL, TPL_SPAN_SLICE, TPL_SPAN_SLICE_RTL
|
|
|
|
from .templates import TPL_SPAN_START, TPL_SPAN_START_RTL, TPL_SPANS
|
|
|
|
from .templates import TPL_TITLE
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2019-03-11 17:52:50 +00:00
|
|
|
DEFAULT_LANG = "en"
|
|
|
|
DEFAULT_DIR = "ltr"
|
2020-07-25 13:01:15 +00:00
|
|
|
DEFAULT_ENTITY_COLOR = "#ddd"
|
|
|
|
DEFAULT_LABEL_COLORS = {
|
|
|
|
"ORG": "#7aecec",
|
|
|
|
"PRODUCT": "#bfeeb7",
|
|
|
|
"GPE": "#feca74",
|
|
|
|
"LOC": "#ff9561",
|
|
|
|
"PERSON": "#aa9cfc",
|
|
|
|
"NORP": "#c887fb",
|
2022-01-20 11:00:28 +00:00
|
|
|
"FAC": "#9cc9cc",
|
2020-07-25 13:01:15 +00:00
|
|
|
"EVENT": "#ffeb80",
|
|
|
|
"LAW": "#ff8197",
|
|
|
|
"LANGUAGE": "#ff8197",
|
|
|
|
"WORK_OF_ART": "#f0d0ff",
|
|
|
|
"DATE": "#bfe1d9",
|
|
|
|
"TIME": "#bfe1d9",
|
|
|
|
"MONEY": "#e4e7d2",
|
|
|
|
"QUANTITY": "#e4e7d2",
|
|
|
|
"ORDINAL": "#e4e7d2",
|
|
|
|
"CARDINAL": "#e4e7d2",
|
|
|
|
"PERCENT": "#e4e7d2",
|
|
|
|
}
|
2019-03-11 17:52:50 +00:00
|
|
|
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2022-03-16 17:14:34 +00:00
|
|
|
class SpanRenderer:
|
|
|
|
"""Render Spans as SVGs."""
|
|
|
|
|
|
|
|
style = "span"
|
|
|
|
|
|
|
|
def __init__(self, options: Dict[str, Any] = {}) -> None:
|
|
|
|
"""Initialise span renderer
|
|
|
|
|
|
|
|
options (dict): Visualiser-specific options (colors, spans)
|
|
|
|
"""
|
|
|
|
# Set up the colors and overall look
|
|
|
|
colors = dict(DEFAULT_LABEL_COLORS)
|
|
|
|
user_colors = registry.displacy_colors.get_all()
|
|
|
|
for user_color in user_colors.values():
|
|
|
|
if callable(user_color):
|
|
|
|
# Since this comes from the function registry, we want to make
|
|
|
|
# sure we support functions that *return* a dict of colors
|
|
|
|
user_color = user_color()
|
|
|
|
if not isinstance(user_color, dict):
|
|
|
|
raise ValueError(Errors.E925.format(obj=type(user_color)))
|
|
|
|
colors.update(user_color)
|
|
|
|
colors.update(options.get("colors", {}))
|
|
|
|
self.default_color = DEFAULT_ENTITY_COLOR
|
|
|
|
self.colors = {label.upper(): color for label, color in colors.items()}
|
|
|
|
|
|
|
|
# Set up how the text and labels will be rendered
|
|
|
|
self.direction = DEFAULT_DIR
|
|
|
|
self.lang = DEFAULT_LANG
|
2022-06-28 18:42:40 +00:00
|
|
|
# These values are in px
|
2022-03-16 17:14:34 +00:00
|
|
|
self.top_offset = options.get("top_offset", 40)
|
2022-06-28 18:42:40 +00:00
|
|
|
# This is how far under the top offset the span labels appear
|
|
|
|
self.span_label_offset = options.get("span_label_offset", 20)
|
|
|
|
self.offset_step = options.get("top_offset_step", 17)
|
2022-03-16 17:14:34 +00:00
|
|
|
|
|
|
|
# Set up which templates will be used
|
|
|
|
template = options.get("template")
|
|
|
|
if template:
|
|
|
|
self.span_template = template["span"]
|
|
|
|
self.span_slice_template = template["slice"]
|
|
|
|
self.span_start_template = template["start"]
|
|
|
|
else:
|
|
|
|
if self.direction == "rtl":
|
|
|
|
self.span_template = TPL_SPAN_RTL
|
|
|
|
self.span_slice_template = TPL_SPAN_SLICE_RTL
|
|
|
|
self.span_start_template = TPL_SPAN_START_RTL
|
|
|
|
else:
|
|
|
|
self.span_template = TPL_SPAN
|
|
|
|
self.span_slice_template = TPL_SPAN_SLICE
|
|
|
|
self.span_start_template = TPL_SPAN_START
|
|
|
|
|
|
|
|
def render(
|
|
|
|
self, parsed: List[Dict[str, Any]], page: bool = False, minify: bool = False
|
|
|
|
) -> str:
|
|
|
|
"""Render complete markup.
|
|
|
|
|
|
|
|
parsed (list): Dependency parses to render.
|
|
|
|
page (bool): Render parses wrapped as full HTML page.
|
|
|
|
minify (bool): Minify HTML markup.
|
|
|
|
RETURNS (str): Rendered HTML markup.
|
|
|
|
"""
|
|
|
|
rendered = []
|
|
|
|
for i, p in enumerate(parsed):
|
|
|
|
if i == 0:
|
|
|
|
settings = p.get("settings", {})
|
|
|
|
self.direction = settings.get("direction", DEFAULT_DIR)
|
|
|
|
self.lang = settings.get("lang", DEFAULT_LANG)
|
|
|
|
rendered.append(self.render_spans(p["tokens"], p["spans"], p.get("title")))
|
|
|
|
|
|
|
|
if page:
|
|
|
|
docs = "".join([TPL_FIGURE.format(content=doc) for doc in rendered])
|
|
|
|
markup = TPL_PAGE.format(content=docs, lang=self.lang, dir=self.direction)
|
|
|
|
else:
|
|
|
|
markup = "".join(rendered)
|
|
|
|
if minify:
|
|
|
|
return minify_html(markup)
|
|
|
|
return markup
|
|
|
|
|
|
|
|
def render_spans(
|
|
|
|
self,
|
|
|
|
tokens: List[str],
|
|
|
|
spans: List[Dict[str, Any]],
|
|
|
|
title: Optional[str],
|
|
|
|
) -> str:
|
|
|
|
"""Render span types in text.
|
|
|
|
|
|
|
|
Spans are rendered per-token, this means that for each token, we check if it's part
|
|
|
|
of a span slice (a member of a span type) or a span start (the starting token of a
|
|
|
|
given span type).
|
|
|
|
|
|
|
|
tokens (list): Individual tokens in the text
|
|
|
|
spans (list): Individual entity spans and their start, end, label, kb_id and kb_url.
|
|
|
|
title (str / None): Document title set in Doc.user_data['title'].
|
|
|
|
"""
|
|
|
|
per_token_info = []
|
2022-07-08 17:20:13 +00:00
|
|
|
# we must sort so that we can correctly describe when spans need to "stack"
|
|
|
|
# which is determined by their start token, then span length (longer spans on top),
|
|
|
|
# then break any remaining ties with the span label
|
|
|
|
spans = sorted(
|
|
|
|
spans,
|
|
|
|
key=lambda s: (
|
|
|
|
s["start_token"],
|
|
|
|
-(s["end_token"] - s["start_token"]),
|
|
|
|
s["label"],
|
|
|
|
),
|
|
|
|
)
|
|
|
|
for s in spans:
|
|
|
|
# this is the vertical 'slot' that the span will be rendered in
|
|
|
|
# vertical_position = span_label_offset + (offset_step * (slot - 1))
|
|
|
|
s["render_slot"] = 0
|
2022-03-16 17:14:34 +00:00
|
|
|
for idx, token in enumerate(tokens):
|
|
|
|
# Identify if a token belongs to a Span (and which) and if it's a
|
|
|
|
# start token of said Span. We'll use this for the final HTML render
|
|
|
|
token_markup: Dict[str, Any] = {}
|
|
|
|
token_markup["text"] = token
|
2022-07-08 17:20:13 +00:00
|
|
|
concurrent_spans = 0
|
2022-03-16 17:14:34 +00:00
|
|
|
entities = []
|
|
|
|
for span in spans:
|
|
|
|
ent = {}
|
|
|
|
if span["start_token"] <= idx < span["end_token"]:
|
2022-07-08 17:20:13 +00:00
|
|
|
concurrent_spans += 1
|
|
|
|
span_start = idx == span["start_token"]
|
2022-03-16 17:14:34 +00:00
|
|
|
ent["label"] = span["label"]
|
2022-07-08 17:20:13 +00:00
|
|
|
ent["is_start"] = span_start
|
|
|
|
if span_start:
|
|
|
|
# When the span starts, we need to know how many other
|
|
|
|
# spans are on the 'span stack' and will be rendered.
|
|
|
|
# This value becomes the vertical render slot for this entire span
|
|
|
|
span["render_slot"] = concurrent_spans
|
|
|
|
ent["render_slot"] = span["render_slot"]
|
2022-03-16 17:14:34 +00:00
|
|
|
kb_id = span.get("kb_id", "")
|
|
|
|
kb_url = span.get("kb_url", "#")
|
|
|
|
ent["kb_link"] = (
|
|
|
|
TPL_KB_LINK.format(kb_id=kb_id, kb_url=kb_url) if kb_id else ""
|
|
|
|
)
|
|
|
|
entities.append(ent)
|
2022-07-08 17:20:13 +00:00
|
|
|
else:
|
|
|
|
# We don't specifically need to do this since we loop
|
|
|
|
# over tokens and spans sorted by their start_token,
|
|
|
|
# so we'll never use a span again after the last token it appears in,
|
|
|
|
# but if we were to use these spans again we'd want to make sure
|
|
|
|
# this value was reset correctly.
|
|
|
|
span["render_slot"] = 0
|
2022-03-16 17:14:34 +00:00
|
|
|
token_markup["entities"] = entities
|
|
|
|
per_token_info.append(token_markup)
|
|
|
|
markup = self._render_markup(per_token_info)
|
|
|
|
markup = TPL_SPANS.format(content=markup, dir=self.direction)
|
|
|
|
if title:
|
|
|
|
markup = TPL_TITLE.format(title=title) + markup
|
|
|
|
return markup
|
|
|
|
|
|
|
|
def _render_markup(self, per_token_info: List[Dict[str, Any]]) -> str:
|
|
|
|
"""Render the markup from per-token information"""
|
|
|
|
markup = ""
|
|
|
|
for token in per_token_info:
|
2022-07-08 17:20:13 +00:00
|
|
|
entities = sorted(token["entities"], key=lambda d: d["render_slot"])
|
|
|
|
# Whitespace tokens disrupt the vertical space (no line height) so that the
|
|
|
|
# span indicators get misaligned. We don't render them as individual
|
|
|
|
# tokens anyway, so we'll just not display a span indicator either.
|
|
|
|
is_whitespace = token["text"].strip() == ""
|
|
|
|
if entities and not is_whitespace:
|
2022-03-16 17:14:34 +00:00
|
|
|
slices = self._get_span_slices(token["entities"])
|
|
|
|
starts = self._get_span_starts(token["entities"])
|
2022-06-28 18:42:40 +00:00
|
|
|
total_height = (
|
|
|
|
self.top_offset
|
|
|
|
+ self.span_label_offset
|
|
|
|
+ (self.offset_step * (len(entities) - 1))
|
|
|
|
)
|
2022-03-16 17:14:34 +00:00
|
|
|
markup += self.span_template.format(
|
2022-06-28 18:42:40 +00:00
|
|
|
text=token["text"],
|
|
|
|
span_slices=slices,
|
|
|
|
span_starts=starts,
|
|
|
|
total_height=total_height,
|
2022-03-16 17:14:34 +00:00
|
|
|
)
|
|
|
|
else:
|
|
|
|
markup += escape_html(token["text"] + " ")
|
|
|
|
return markup
|
|
|
|
|
|
|
|
def _get_span_slices(self, entities: List[Dict]) -> str:
|
|
|
|
"""Get the rendered markup of all Span slices"""
|
|
|
|
span_slices = []
|
2022-07-08 17:20:13 +00:00
|
|
|
for entity in entities:
|
|
|
|
# rather than iterate over multiples of offset_step, we use entity['render_slot']
|
|
|
|
# to determine the vertical position, since that tells where
|
|
|
|
# the span starts vertically so we can extend it horizontally,
|
|
|
|
# past other spans that might have already ended
|
2022-03-16 17:14:34 +00:00
|
|
|
color = self.colors.get(entity["label"].upper(), self.default_color)
|
2022-07-08 17:20:13 +00:00
|
|
|
top_offset = self.top_offset + (
|
|
|
|
self.offset_step * (entity["render_slot"] - 1)
|
|
|
|
)
|
2022-03-16 17:14:34 +00:00
|
|
|
span_slice = self.span_slice_template.format(
|
2022-07-08 17:20:13 +00:00
|
|
|
bg=color,
|
|
|
|
top_offset=top_offset,
|
2022-03-16 17:14:34 +00:00
|
|
|
)
|
|
|
|
span_slices.append(span_slice)
|
|
|
|
return "".join(span_slices)
|
|
|
|
|
|
|
|
def _get_span_starts(self, entities: List[Dict]) -> str:
|
|
|
|
"""Get the rendered markup of all Span start tokens"""
|
|
|
|
span_starts = []
|
2022-07-08 17:20:13 +00:00
|
|
|
for entity in entities:
|
2022-03-16 17:14:34 +00:00
|
|
|
color = self.colors.get(entity["label"].upper(), self.default_color)
|
2022-07-08 17:20:13 +00:00
|
|
|
top_offset = self.top_offset + (
|
|
|
|
self.offset_step * (entity["render_slot"] - 1)
|
|
|
|
)
|
2022-03-16 17:14:34 +00:00
|
|
|
span_start = (
|
|
|
|
self.span_start_template.format(
|
|
|
|
bg=color,
|
2022-07-08 17:20:13 +00:00
|
|
|
top_offset=top_offset,
|
2022-03-16 17:14:34 +00:00
|
|
|
label=entity["label"],
|
|
|
|
kb_link=entity["kb_link"],
|
|
|
|
)
|
|
|
|
if entity["is_start"]
|
|
|
|
else ""
|
|
|
|
)
|
|
|
|
span_starts.append(span_start)
|
|
|
|
return "".join(span_starts)
|
|
|
|
|
|
|
|
|
2020-07-12 12:03:23 +00:00
|
|
|
class DependencyRenderer:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render dependency parses as SVGs."""
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
|
|
|
|
style = "dep"
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def __init__(self, options: Dict[str, Any] = {}) -> None:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Initialise dependency renderer.
|
|
|
|
|
|
|
|
options (dict): Visualiser-specific options (compact, word_spacing,
|
2017-10-27 12:39:19 +00:00
|
|
|
arrow_spacing, arrow_width, arrow_stroke, distance, offset_x,
|
|
|
|
color, bg, font)
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
self.compact = options.get("compact", False)
|
|
|
|
self.word_spacing = options.get("word_spacing", 45)
|
|
|
|
self.arrow_spacing = options.get("arrow_spacing", 12 if self.compact else 20)
|
|
|
|
self.arrow_width = options.get("arrow_width", 6 if self.compact else 10)
|
|
|
|
self.arrow_stroke = options.get("arrow_stroke", 2)
|
|
|
|
self.distance = options.get("distance", 150 if self.compact else 175)
|
|
|
|
self.offset_x = options.get("offset_x", 50)
|
|
|
|
self.color = options.get("color", "#000000")
|
|
|
|
self.bg = options.get("bg", "#ffffff")
|
|
|
|
self.font = options.get("font", "Arial")
|
2019-03-11 17:52:50 +00:00
|
|
|
self.direction = DEFAULT_DIR
|
|
|
|
self.lang = DEFAULT_LANG
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def render(
|
|
|
|
self, parsed: List[Dict[str, Any]], page: bool = False, minify: bool = False
|
|
|
|
) -> str:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render complete markup.
|
|
|
|
|
|
|
|
parsed (list): Dependency parses to render.
|
|
|
|
page (bool): Render parses wrapped as full HTML page.
|
|
|
|
minify (bool): Minify HTML markup.
|
2020-05-24 15:20:58 +00:00
|
|
|
RETURNS (str): Rendered SVG or HTML markup.
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
💫 Port master changes over to develop (#2979)
* Create aryaprabhudesai.md (#2681)
* Update _install.jade (#2688)
Typo fix: "models" -> "model"
* Add FAC to spacy.explain (resolves #2706)
* Remove docstrings for deprecated arguments (see #2703)
* When calling getoption() in conftest.py, pass a default option (#2709)
* When calling getoption() in conftest.py, pass a default option
This is necessary to allow testing an installed spacy by running:
pytest --pyargs spacy
* Add contributor agreement
* update bengali token rules for hyphen and digits (#2731)
* Less norm computations in token similarity (#2730)
* Less norm computations in token similarity
* Contributor agreement
* Remove ')' for clarity (#2737)
Sorry, don't mean to be nitpicky, I just noticed this when going through the CLI and thought it was a quick fix. That said, if this was intention than please let me know.
* added contributor agreement for mbkupfer (#2738)
* Basic support for Telugu language (#2751)
* Lex _attrs for polish language (#2750)
* Signed spaCy contributor agreement
* Added polish version of english lex_attrs
* Introduces a bulk merge function, in order to solve issue #653 (#2696)
* Fix comment
* Introduce bulk merge to increase performance on many span merges
* Sign contributor agreement
* Implement pull request suggestions
* Describe converters more explicitly (see #2643)
* Add multi-threading note to Language.pipe (resolves #2582) [ci skip]
* Fix formatting
* Fix dependency scheme docs (closes #2705) [ci skip]
* Don't set stop word in example (closes #2657) [ci skip]
* Add words to portuguese language _num_words (#2759)
* Add words to portuguese language _num_words
* Add words to portuguese language _num_words
* Update Indonesian model (#2752)
* adding e-KTP in tokenizer exceptions list
* add exception token
* removing lines with containing space as it won't matter since we use .split() method in the end, added new tokens in exception
* add tokenizer exceptions list
* combining base_norms with norm_exceptions
* adding norm_exception
* fix double key in lemmatizer
* remove unused import on punctuation.py
* reformat stop_words to reduce number of lines, improve readibility
* updating tokenizer exception
* implement is_currency for lang/id
* adding orth_first_upper in tokenizer_exceptions
* update the norm_exception list
* remove bunch of abbreviations
* adding contributors file
* Fixed spaCy+Keras example (#2763)
* bug fixes in keras example
* created contributor agreement
* Adding French hyphenated first name (#2786)
* Fix typo (closes #2784)
* Fix typo (#2795) [ci skip]
Fixed typo on line 6 "regcognizer --> recognizer"
* Adding basic support for Sinhala language. (#2788)
* adding Sinhala language package, stop words, examples and lex_attrs.
* Adding contributor agreement
* Updating contributor agreement
* Also include lowercase norm exceptions
* Fix error (#2802)
* Fix error
ValueError: cannot resize an array that references or is referenced
by another array in this way. Use the resize function
* added spaCy Contributor Agreement
* Add charlax's contributor agreement (#2805)
* agreement of contributor, may I introduce a tiny pl languge contribution (#2799)
* Contributors agreement
* Contributors agreement
* Contributors agreement
* Add jupyter=True to displacy.render in documentation (#2806)
* Revert "Also include lowercase norm exceptions"
This reverts commit 70f4e8adf37cfcfab60be2b97d6deae949b30e9e.
* Remove deprecated encoding argument to msgpack
* Set up dependency tree pattern matching skeleton (#2732)
* Fix bug when too many entity types. Fixes #2800
* Fix Python 2 test failure
* Require older msgpack-numpy
* Restore encoding arg on msgpack-numpy
* Try to fix version pin for msgpack-numpy
* Update Portuguese Language (#2790)
* Add words to portuguese language _num_words
* Add words to portuguese language _num_words
* Portuguese - Add/remove stopwords, fix tokenizer, add currency symbols
* Extended punctuation and norm_exceptions in the Portuguese language
* Correct error in spacy universe docs concerning spacy-lookup (#2814)
* Update Keras Example for (Parikh et al, 2016) implementation (#2803)
* bug fixes in keras example
* created contributor agreement
* baseline for Parikh model
* initial version of parikh 2016 implemented
* tested asymmetric models
* fixed grevious error in normalization
* use standard SNLI test file
* begin to rework parikh example
* initial version of running example
* start to document the new version
* start to document the new version
* Update Decompositional Attention.ipynb
* fixed calls to similarity
* updated the README
* import sys package duh
* simplified indexing on mapping word to IDs
* stupid python indent error
* added code from https://github.com/tensorflow/tensorflow/issues/3388 for tf bug workaround
* Fix typo (closes #2815) [ci skip]
* Update regex version dependency
* Set version to 2.0.13.dev3
* Skip seemingly problematic test
* Remove problematic test
* Try previous version of regex
* Revert "Remove problematic test"
This reverts commit bdebbef45552d698d390aa430b527ee27830f11b.
* Unskip test
* Try older version of regex
* 💫 Update training examples and use minibatching (#2830)
<!--- Provide a general summary of your changes in the title. -->
## Description
Update the training examples in `/examples/training` to show usage of spaCy's `minibatch` and `compounding` helpers ([see here](https://spacy.io/usage/training#tips-batch-size) for details). The lack of batching in the examples has caused some confusion in the past, especially for beginners who would copy-paste the examples, update them with large training sets and experienced slow and unsatisfying results.
### Types of change
enhancements
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Visual C++ link updated (#2842) (closes #2841) [ci skip]
* New landing page
* Add contribution agreement
* Correcting lang/ru/examples.py (#2845)
* Correct some grammatical inaccuracies in lang\ru\examples.py; filled Contributor Agreement
* Correct some grammatical inaccuracies in lang\ru\examples.py
* Move contributor agreement to separate file
* Set version to 2.0.13.dev4
* Add Persian(Farsi) language support (#2797)
* Also include lowercase norm exceptions
* Remove in favour of https://github.com/explosion/spaCy/graphs/contributors
* Rule-based French Lemmatizer (#2818)
<!--- Provide a general summary of your changes in the title. -->
## Description
<!--- Use this section to describe your changes. If your changes required
testing, include information about the testing environment and the tests you
ran. If your test fixes a bug reported in an issue, don't forget to include the
issue number. If your PR is still a work in progress, that's totally fine – just
include a note to let us know. -->
Add a rule-based French Lemmatizer following the english one and the excellent PR for [greek language optimizations](https://github.com/explosion/spaCy/pull/2558) to adapt the Lemmatizer class.
### Types of change
<!-- What type of change does your PR cover? Is it a bug fix, an enhancement
or new feature, or a change to the documentation? -->
- Lemma dictionary used can be found [here](http://infolingu.univ-mlv.fr/DonneesLinguistiques/Dictionnaires/telechargement.html), I used the XML version.
- Add several files containing exhaustive list of words for each part of speech
- Add some lemma rules
- Add POS that are not checked in the standard Lemmatizer, i.e PRON, DET, ADV and AUX
- Modify the Lemmatizer class to check in lookup table as a last resort if POS not mentionned
- Modify the lemmatize function to check in lookup table as a last resort
- Init files are updated so the model can support all the functionalities mentioned above
- Add words to tokenizer_exceptions_list.py in respect to regex used in tokenizer_exceptions.py
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [X] I have submitted the spaCy Contributor Agreement.
- [X] I ran the tests, and all new and existing tests passed.
- [X] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Set version to 2.0.13
* Fix formatting and consistency
* Update docs for new version [ci skip]
* Increment version [ci skip]
* Add info on wheels [ci skip]
* Adding "This is a sentence" example to Sinhala (#2846)
* Add wheels badge
* Update badge [ci skip]
* Update README.rst [ci skip]
* Update murmurhash pin
* Increment version to 2.0.14.dev0
* Update GPU docs for v2.0.14
* Add wheel to setup_requires
* Import prefer_gpu and require_gpu functions from Thinc
* Add tests for prefer_gpu() and require_gpu()
* Update requirements and setup.py
* Workaround bug in thinc require_gpu
* Set version to v2.0.14
* Update push-tag script
* Unhack prefer_gpu
* Require thinc 6.10.6
* Update prefer_gpu and require_gpu docs [ci skip]
* Fix specifiers for GPU
* Set version to 2.0.14.dev1
* Set version to 2.0.14
* Update Thinc version pin
* Increment version
* Fix msgpack-numpy version pin
* Increment version
* Update version to 2.0.16
* Update version [ci skip]
* Redundant ')' in the Stop words' example (#2856)
<!--- Provide a general summary of your changes in the title. -->
## Description
<!--- Use this section to describe your changes. If your changes required
testing, include information about the testing environment and the tests you
ran. If your test fixes a bug reported in an issue, don't forget to include the
issue number. If your PR is still a work in progress, that's totally fine – just
include a note to let us know. -->
### Types of change
<!-- What type of change does your PR cover? Is it a bug fix, an enhancement
or new feature, or a change to the documentation? -->
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [ ] I have submitted the spaCy Contributor Agreement.
- [ ] I ran the tests, and all new and existing tests passed.
- [ ] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Documentation improvement regarding joblib and SO (#2867)
Some documentation improvements
## Description
1. Fixed the dead URL to joblib
2. Fixed Stack Overflow brand name (with space)
### Types of change
Documentation
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
* raise error when setting overlapping entities as doc.ents (#2880)
* Fix out-of-bounds access in NER training
The helper method state.B(1) gets the index of the first token of the
buffer, or -1 if no such token exists. Normally this is safe because we
pass this to functions like state.safe_get(), which returns an empty
token. Here we used it directly as an array index, which is not okay!
This error may have been the cause of out-of-bounds access errors during
training. Similar errors may still be around, so much be hunted down.
Hunting this one down took a long time...I printed out values across
training runs and diffed, looking for points of divergence between
runs, when no randomness should be allowed.
* Change PyThaiNLP Url (#2876)
* Fix missing comma
* Add example showing a fix-up rule for space entities
* Set version to 2.0.17.dev0
* Update regex version
* Revert "Update regex version"
This reverts commit 62358dd867d15bc6a475942dff34effba69dd70a.
* Try setting older regex version, to align with conda
* Set version to 2.0.17
* Add spacy-js to universe [ci-skip]
* Add spacy-raspberry to universe (closes #2889)
* Add script to validate universe json [ci skip]
* Removed space in docs + added contributor indo (#2909)
* - removed unneeded space in documentation
* - added contributor info
* Allow input text of length up to max_length, inclusive (#2922)
* Include universe spec for spacy-wordnet component (#2919)
* feat: include universe spec for spacy-wordnet component
* chore: include spaCy contributor agreement
* Minor formatting changes [ci skip]
* Fix image [ci skip]
Twitter URL doesn't work on live site
* Check if the word is in one of the regular lists specific to each POS (#2886)
* 💫 Create random IDs for SVGs to prevent ID clashes (#2927)
Resolves #2924.
## Description
Fixes problem where multiple visualizations in Jupyter notebooks would have clashing arc IDs, resulting in weirdly positioned arc labels. Generating a random ID prefix so even identical parses won't receive the same IDs for consistency (even if effect of ID clash isn't noticable here.)
### Types of change
bug fix
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Fix typo [ci skip]
* fixes symbolic link on py3 and windows (#2949)
* fixes symbolic link on py3 and windows
during setup of spacy using command
python -m spacy link en_core_web_sm en
closes #2948
* Update spacy/compat.py
Co-Authored-By: cicorias <cicorias@users.noreply.github.com>
* Fix formatting
* Update universe [ci skip]
* Catalan Language Support (#2940)
* Catalan language Support
* Ddding Catalan to documentation
* Sort languages alphabetically [ci skip]
* Update tests for pytest 4.x (#2965)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Replace marks in params for pytest 4.0 compat ([see here](https://docs.pytest.org/en/latest/deprecations.html#marks-in-pytest-mark-parametrize))
- [x] Un-xfail passing tests (some fixes in a recent update resolved a bunch of issues, but tests were apparently never updated here)
### Types of change
<!-- What type of change does your PR cover? Is it a bug fix, an enhancement
or new feature, or a change to the documentation? -->
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
* Fix regex pin to harmonize with conda (#2964)
* Update README.rst
* Fix bug where Vocab.prune_vector did not use 'batch_size' (#2977)
Fixes #2976
* Fix typo
* Fix typo
* Remove duplicate file
* Require thinc 7.0.0.dev2
Fixes bug in gpu_ops that would use cupy instead of numpy on CPU
* Add missing import
* Fix error IDs
* Fix tests
2018-11-29 15:30:29 +00:00
|
|
|
# Create a random ID prefix to make sure parses don't receive the
|
|
|
|
# same ID, even if they're identical
|
2018-12-27 13:46:02 +00:00
|
|
|
id_prefix = uuid.uuid4().hex
|
2019-03-11 17:52:50 +00:00
|
|
|
rendered = []
|
|
|
|
for i, p in enumerate(parsed):
|
|
|
|
if i == 0:
|
2019-04-03 08:13:16 +00:00
|
|
|
settings = p.get("settings", {})
|
|
|
|
self.direction = settings.get("direction", DEFAULT_DIR)
|
|
|
|
self.lang = settings.get("lang", DEFAULT_LANG)
|
2019-12-22 00:53:56 +00:00
|
|
|
render_id = f"{id_prefix}-{i}"
|
2019-03-11 17:52:50 +00:00
|
|
|
svg = self.render_svg(render_id, p["words"], p["arcs"])
|
|
|
|
rendered.append(svg)
|
2017-05-14 15:50:23 +00:00
|
|
|
if page:
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
content = "".join([TPL_FIGURE.format(content=svg) for svg in rendered])
|
2019-03-11 17:52:50 +00:00
|
|
|
markup = TPL_PAGE.format(
|
|
|
|
content=content, lang=self.lang, dir=self.direction
|
|
|
|
)
|
2017-05-14 15:50:23 +00:00
|
|
|
else:
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
markup = "".join(rendered)
|
2017-05-14 15:50:23 +00:00
|
|
|
if minify:
|
|
|
|
return minify_html(markup)
|
|
|
|
return markup
|
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def render_svg(
|
|
|
|
self,
|
|
|
|
render_id: Union[int, str],
|
|
|
|
words: List[Dict[str, Any]],
|
|
|
|
arcs: List[Dict[str, Any]],
|
|
|
|
) -> str:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render SVG.
|
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
render_id (Union[int, str]): Unique ID, typically index of document.
|
2017-05-14 15:50:23 +00:00
|
|
|
words (list): Individual words and their tags.
|
|
|
|
arcs (list): Individual arcs and their start, end, direction and label.
|
2020-05-24 15:20:58 +00:00
|
|
|
RETURNS (str): Rendered SVG markup.
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
|
|
|
self.levels = self.get_levels(arcs)
|
2022-04-05 07:08:02 +00:00
|
|
|
self.highest_level = max(self.levels.values(), default=0)
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
self.offset_y = self.distance / 2 * self.highest_level + self.arrow_stroke
|
|
|
|
self.width = self.offset_x + len(words) * self.distance
|
|
|
|
self.height = self.offset_y + 3 * self.word_spacing
|
2017-05-14 15:50:23 +00:00
|
|
|
self.id = render_id
|
2020-07-25 13:01:15 +00:00
|
|
|
words_svg = [
|
2020-03-25 11:28:12 +00:00
|
|
|
self.render_word(w["text"], w["tag"], w.get("lemma", None), i)
|
|
|
|
for i, w in enumerate(words)
|
|
|
|
]
|
2020-07-25 13:01:15 +00:00
|
|
|
arcs_svg = [
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
self.render_arrow(a["label"], a["start"], a["end"], a["dir"], i)
|
|
|
|
for i, a in enumerate(arcs)
|
|
|
|
]
|
2020-07-25 13:01:15 +00:00
|
|
|
content = "".join(words_svg) + "".join(arcs_svg)
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
return TPL_DEP_SVG.format(
|
|
|
|
id=self.id,
|
|
|
|
width=self.width,
|
|
|
|
height=self.height,
|
|
|
|
color=self.color,
|
|
|
|
bg=self.bg,
|
|
|
|
font=self.font,
|
|
|
|
content=content,
|
2019-03-11 17:52:50 +00:00
|
|
|
dir=self.direction,
|
|
|
|
lang=self.lang,
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
)
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def render_word(self, text: str, tag: str, lemma: str, i: int) -> str:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render individual word.
|
|
|
|
|
2020-05-24 15:20:58 +00:00
|
|
|
text (str): Word text.
|
|
|
|
tag (str): Part-of-speech tag.
|
2017-05-14 15:50:23 +00:00
|
|
|
i (int): Unique ID, typically word index.
|
2020-05-24 15:20:58 +00:00
|
|
|
RETURNS (str): Rendered SVG markup.
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
y = self.offset_y + self.word_spacing
|
|
|
|
x = self.offset_x + i * self.distance
|
2019-03-11 17:52:50 +00:00
|
|
|
if self.direction == "rtl":
|
|
|
|
x = self.width - x
|
escape html in displacy.render (#2378) (closes #2361)
## Description
Fix for issue #2361 :
replace &, <, >, " with &amp; , &lt; , &gt; , &quot; in before rendering svg
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [ ] I ran the tests, and all new and existing tests passed.
(As discussed in the comments to #2361)
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-05-28 16:36:41 +00:00
|
|
|
html_text = escape_html(text)
|
2020-02-22 13:11:51 +00:00
|
|
|
if lemma is not None:
|
2020-03-25 11:28:12 +00:00
|
|
|
return TPL_DEP_WORDS_LEMMA.format(
|
|
|
|
text=html_text, tag=tag, lemma=lemma, x=x, y=y
|
|
|
|
)
|
escape html in displacy.render (#2378) (closes #2361)
## Description
Fix for issue #2361 :
replace &, <, >, " with &amp; , &lt; , &gt; , &quot; in before rendering svg
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [ ] I ran the tests, and all new and existing tests passed.
(As discussed in the comments to #2361)
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-05-28 16:36:41 +00:00
|
|
|
return TPL_DEP_WORDS.format(text=html_text, tag=tag, x=x, y=y)
|
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def render_arrow(
|
|
|
|
self, label: str, start: int, end: int, direction: str, i: int
|
|
|
|
) -> str:
|
2019-03-11 17:52:50 +00:00
|
|
|
"""Render individual arrow.
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2020-05-24 15:20:58 +00:00
|
|
|
label (str): Dependency label.
|
2017-05-14 15:50:23 +00:00
|
|
|
start (int): Index of start word.
|
|
|
|
end (int): Index of end word.
|
2020-05-24 15:20:58 +00:00
|
|
|
direction (str): Arrow direction, 'left' or 'right'.
|
2017-05-14 15:50:23 +00:00
|
|
|
i (int): Unique ID, typically arrow index.
|
2020-05-24 15:20:58 +00:00
|
|
|
RETURNS (str): Rendered SVG markup.
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
2019-08-20 13:51:37 +00:00
|
|
|
if start < 0 or end < 0:
|
|
|
|
error_args = dict(start=start, end=end, label=label, dir=direction)
|
2019-08-21 12:00:37 +00:00
|
|
|
raise ValueError(Errors.E157.format(**error_args))
|
2022-04-05 07:08:02 +00:00
|
|
|
level = self.levels[(start, end, label)]
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
x_start = self.offset_x + start * self.distance + self.arrow_spacing
|
2019-03-11 17:52:50 +00:00
|
|
|
if self.direction == "rtl":
|
|
|
|
x_start = self.width - x_start
|
2017-05-14 15:50:23 +00:00
|
|
|
y = self.offset_y
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
x_end = (
|
|
|
|
self.offset_x
|
|
|
|
+ (end - start) * self.distance
|
|
|
|
+ start * self.distance
|
|
|
|
- self.arrow_spacing * (self.highest_level - level) / 4
|
|
|
|
)
|
2019-03-11 17:52:50 +00:00
|
|
|
if self.direction == "rtl":
|
|
|
|
x_end = self.width - x_end
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
y_curve = self.offset_y - level * self.distance / 2
|
2017-06-03 11:25:32 +00:00
|
|
|
if self.compact:
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
y_curve = self.offset_y - level * self.distance / 6
|
2022-04-05 07:08:02 +00:00
|
|
|
if y_curve == 0 and max(self.levels.values(), default=0) > 5:
|
2017-05-14 15:50:23 +00:00
|
|
|
y_curve = -self.distance
|
|
|
|
arrowhead = self.get_arrowhead(direction, x_start, y, x_end)
|
|
|
|
arc = self.get_arc(x_start, y, y_curve, x_end)
|
2019-03-11 17:52:50 +00:00
|
|
|
label_side = "right" if self.direction == "rtl" else "left"
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
return TPL_DEP_ARCS.format(
|
|
|
|
id=self.id,
|
|
|
|
i=i,
|
|
|
|
stroke=self.arrow_stroke,
|
|
|
|
head=arrowhead,
|
|
|
|
label=label,
|
2019-03-11 17:52:50 +00:00
|
|
|
label_side=label_side,
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
arc=arc,
|
|
|
|
)
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def get_arc(self, x_start: int, y: int, y_curve: int, x_end: int) -> str:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render individual arc.
|
|
|
|
|
|
|
|
x_start (int): X-coordinate of arrow start point.
|
|
|
|
y (int): Y-coordinate of arrow start and end point.
|
|
|
|
y_curve (int): Y-corrdinate of Cubic Bézier y_curve point.
|
|
|
|
x_end (int): X-coordinate of arrow end point.
|
2020-05-24 15:20:58 +00:00
|
|
|
RETURNS (str): Definition of the arc path ('d' attribute).
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
|
|
|
template = "M{x},{y} C{x},{c} {e},{c} {e},{y}"
|
|
|
|
if self.compact:
|
|
|
|
template = "M{x},{y} {x},{c} {e},{c} {e},{y}"
|
|
|
|
return template.format(x=x_start, y=y, c=y_curve, e=x_end)
|
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def get_arrowhead(self, direction: str, x: int, y: int, end: int) -> str:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render individual arrow head.
|
|
|
|
|
2020-05-24 15:20:58 +00:00
|
|
|
direction (str): Arrow direction, 'left' or 'right'.
|
2017-05-14 15:50:23 +00:00
|
|
|
x (int): X-coordinate of arrow start point.
|
|
|
|
y (int): Y-coordinate of arrow start and end point.
|
|
|
|
end (int): X-coordinate of arrow end point.
|
2020-05-24 15:20:58 +00:00
|
|
|
RETURNS (str): Definition of the arrow head path ('d' attribute).
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
if direction == "left":
|
2020-07-25 13:01:15 +00:00
|
|
|
p1, p2, p3 = (x, x - self.arrow_width + 2, x + self.arrow_width - 2)
|
2017-05-14 15:50:23 +00:00
|
|
|
else:
|
2020-07-25 13:01:15 +00:00
|
|
|
p1, p2, p3 = (end, end + self.arrow_width - 2, end - self.arrow_width + 2)
|
|
|
|
return f"M{p1},{y + 2} L{p2},{y - self.arrow_width} {p3},{y - self.arrow_width}"
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2022-04-05 07:08:02 +00:00
|
|
|
def get_levels(self, arcs: List[Dict[str, Any]]) -> Dict[Tuple[int, int, str], int]:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Calculate available arc height "levels".
|
|
|
|
Used to calculate arrow heights dynamically and without wasting space.
|
|
|
|
|
|
|
|
args (list): Individual arcs and their start, end, direction and label.
|
2022-04-05 07:08:02 +00:00
|
|
|
RETURNS (dict): Arc levels keyed by (start, end, label).
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
2022-04-14 14:48:00 +00:00
|
|
|
arcs = [dict(t) for t in {tuple(sorted(arc.items())) for arc in arcs}]
|
2022-04-05 07:08:02 +00:00
|
|
|
length = max([arc["end"] for arc in arcs], default=0)
|
|
|
|
max_level = [0] * length
|
|
|
|
levels = {}
|
|
|
|
for arc in sorted(arcs, key=lambda arc: arc["end"] - arc["start"]):
|
|
|
|
level = max(max_level[arc["start"] : arc["end"]]) + 1
|
|
|
|
for i in range(arc["start"], arc["end"]):
|
|
|
|
max_level[i] = level
|
|
|
|
levels[(arc["start"], arc["end"], arc["label"])] = level
|
|
|
|
return levels
|
2017-05-14 15:50:23 +00:00
|
|
|
|
|
|
|
|
2020-07-12 12:03:23 +00:00
|
|
|
class EntityRenderer:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render named entities as HTML."""
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
|
|
|
|
style = "ent"
|
2017-05-14 15:50:23 +00:00
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def __init__(self, options: Dict[str, Any] = {}) -> None:
|
2022-03-16 17:14:34 +00:00
|
|
|
"""Initialise entity renderer.
|
2017-05-14 15:50:23 +00:00
|
|
|
|
|
|
|
options (dict): Visualiser-specific options (colors, ents)
|
|
|
|
"""
|
2020-07-25 13:01:15 +00:00
|
|
|
colors = dict(DEFAULT_LABEL_COLORS)
|
2019-11-07 10:45:22 +00:00
|
|
|
user_colors = registry.displacy_colors.get_all()
|
2019-08-13 13:59:55 +00:00
|
|
|
for user_color in user_colors.values():
|
2020-09-03 21:05:41 +00:00
|
|
|
if callable(user_color):
|
|
|
|
# Since this comes from the function registry, we want to make
|
|
|
|
# sure we support functions that *return* a dict of colors
|
|
|
|
user_color = user_color()
|
|
|
|
if not isinstance(user_color, dict):
|
|
|
|
raise ValueError(Errors.E925.format(obj=type(user_color)))
|
2019-08-13 13:59:55 +00:00
|
|
|
colors.update(user_color)
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
colors.update(options.get("colors", {}))
|
2020-07-25 13:01:15 +00:00
|
|
|
self.default_color = DEFAULT_ENTITY_COLOR
|
2020-08-21 09:51:31 +00:00
|
|
|
self.colors = {label.upper(): color for label, color in colors.items()}
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
self.ents = options.get("ents", None)
|
2020-08-21 09:51:31 +00:00
|
|
|
if self.ents is not None:
|
|
|
|
self.ents = [ent.upper() for ent in self.ents]
|
2019-03-11 17:52:50 +00:00
|
|
|
self.direction = DEFAULT_DIR
|
|
|
|
self.lang = DEFAULT_LANG
|
2019-08-16 16:39:25 +00:00
|
|
|
template = options.get("template")
|
|
|
|
if template:
|
|
|
|
self.ent_template = template
|
|
|
|
else:
|
|
|
|
if self.direction == "rtl":
|
|
|
|
self.ent_template = TPL_ENT_RTL
|
|
|
|
else:
|
|
|
|
self.ent_template = TPL_ENT
|
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def render(
|
|
|
|
self, parsed: List[Dict[str, Any]], page: bool = False, minify: bool = False
|
|
|
|
) -> str:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render complete markup.
|
|
|
|
|
|
|
|
parsed (list): Dependency parses to render.
|
|
|
|
page (bool): Render parses wrapped as full HTML page.
|
|
|
|
minify (bool): Minify HTML markup.
|
2020-05-24 15:20:58 +00:00
|
|
|
RETURNS (str): Rendered HTML markup.
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
2019-03-11 17:52:50 +00:00
|
|
|
rendered = []
|
|
|
|
for i, p in enumerate(parsed):
|
|
|
|
if i == 0:
|
2019-04-03 08:13:16 +00:00
|
|
|
settings = p.get("settings", {})
|
|
|
|
self.direction = settings.get("direction", DEFAULT_DIR)
|
|
|
|
self.lang = settings.get("lang", DEFAULT_LANG)
|
|
|
|
rendered.append(self.render_ents(p["text"], p["ents"], p.get("title")))
|
2017-05-14 15:50:23 +00:00
|
|
|
if page:
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
docs = "".join([TPL_FIGURE.format(content=doc) for doc in rendered])
|
2019-03-11 17:52:50 +00:00
|
|
|
markup = TPL_PAGE.format(content=docs, lang=self.lang, dir=self.direction)
|
2017-05-14 15:50:23 +00:00
|
|
|
else:
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
markup = "".join(rendered)
|
2017-05-14 15:50:23 +00:00
|
|
|
if minify:
|
|
|
|
return minify_html(markup)
|
|
|
|
return markup
|
|
|
|
|
2020-07-25 13:01:15 +00:00
|
|
|
def render_ents(
|
|
|
|
self, text: str, spans: List[Dict[str, Any]], title: Optional[str]
|
|
|
|
) -> str:
|
2017-05-14 15:50:23 +00:00
|
|
|
"""Render entities in text.
|
|
|
|
|
2020-05-24 15:20:58 +00:00
|
|
|
text (str): Original text.
|
2021-09-13 06:15:07 +00:00
|
|
|
spans (list): Individual entity spans and their start, end, label, kb_id and kb_url.
|
2020-05-24 16:51:10 +00:00
|
|
|
title (str / None): Document title set in Doc.user_data['title'].
|
2017-05-14 15:50:23 +00:00
|
|
|
"""
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
markup = ""
|
2017-05-14 15:50:23 +00:00
|
|
|
offset = 0
|
|
|
|
for span in spans:
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
label = span["label"]
|
|
|
|
start = span["start"]
|
|
|
|
end = span["end"]
|
2021-09-16 07:22:38 +00:00
|
|
|
kb_id = span.get("kb_id", "")
|
2021-09-23 09:59:02 +00:00
|
|
|
kb_url = span.get("kb_url", "#")
|
|
|
|
kb_link = TPL_KB_LINK.format(kb_id=kb_id, kb_url=kb_url) if kb_id else ""
|
2019-08-16 16:39:25 +00:00
|
|
|
additional_params = span.get("params", {})
|
2019-02-21 13:30:39 +00:00
|
|
|
entity = escape_html(text[start:end])
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
fragments = text[offset:start].split("\n")
|
2017-05-14 15:50:23 +00:00
|
|
|
for i, fragment in enumerate(fragments):
|
2019-02-21 13:30:39 +00:00
|
|
|
markup += escape_html(fragment)
|
💫 Tidy up and auto-format .py files (#2983)
<!--- Provide a general summary of your changes in the title. -->
## Description
- [x] Use [`black`](https://github.com/ambv/black) to auto-format all `.py` files.
- [x] Update flake8 config to exclude very large files (lemmatization tables etc.)
- [x] Update code to be compatible with flake8 rules
- [x] Fix various small bugs, inconsistencies and messy stuff in the language data
- [x] Update docs to explain new code style (`black`, `flake8`, when to use `# fmt: off` and `# fmt: on` and what `# noqa` means)
Once #2932 is merged, which auto-formats and tidies up the CLI, we'll be able to run `flake8 spacy` actually get meaningful results.
At the moment, the code style and linting isn't applied automatically, but I'm hoping that the new [GitHub Actions](https://github.com/features/actions) will let us auto-format pull requests and post comments with relevant linting information.
### Types of change
enhancement, code style
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-11-30 16:03:03 +00:00
|
|
|
if len(fragments) > 1 and i != len(fragments) - 1:
|
|
|
|
markup += "</br>"
|
2017-05-14 23:24:57 +00:00
|
|
|
if self.ents is None or label.upper() in self.ents:
|
|
|
|
color = self.colors.get(label.upper(), self.default_color)
|
2021-09-23 09:59:02 +00:00
|
|
|
ent_settings = {
|
|
|
|
"label": label,
|
|
|
|
"text": entity,
|
|
|
|
"bg": color,
|
|
|
|
"kb_link": kb_link,
|
|
|
|
}
|
2019-08-16 16:39:25 +00:00
|
|
|
ent_settings.update(additional_params)
|
|
|
|
markup += self.ent_template.format(**ent_settings)
|
2017-05-14 15:50:23 +00:00
|
|
|
else:
|
|
|
|
markup += entity
|
|
|
|
offset = end
|
2020-07-29 16:48:39 +00:00
|
|
|
fragments = text[offset:].split("\n")
|
|
|
|
for i, fragment in enumerate(fragments):
|
|
|
|
markup += escape_html(fragment)
|
|
|
|
if len(fragments) > 1 and i != len(fragments) - 1:
|
|
|
|
markup += "</br>"
|
2019-03-11 17:52:50 +00:00
|
|
|
markup = TPL_ENTS.format(content=markup, dir=self.direction)
|
2017-05-14 15:50:23 +00:00
|
|
|
if title:
|
|
|
|
markup = TPL_TITLE.format(title=title) + markup
|
|
|
|
return markup
|