Merge branch 'master' of https://github.com/explosion/spaCy

.github/ISSUE_TEMPLATE.md

@@ -1,7 +1,7 @@
 <!--- Please provide a summary in the title and describe your issue here.
 Is this a bug or feature request? If a bug, include all the steps that led to the issue.
 
-If you're looking for help with your code, consider posting a question on StackOverflow instead:
+If you're looking for help with your code, consider posting a question on Stack Overflow instead:
 http://stackoverflow.com/questions/tagged/spacy -->
 
 

.github/ISSUE_TEMPLATE/05_other.md

@@ -1,11 +1,11 @@
 ---
 name: "\U0001F4AC Anything else?"
 about: For general usage questions or help with your code, please consider
-  posting on StackOverflow instead.
+  posting on Stack Overflow instead.
 
 ---
 
-<!-- Describe your issue here. Please keep in mind that the GitHub issue tracker is mostly intended for reports related to the spaCy code base and source, and for bugs and feature requests. If you're looking for help with your code, consider posting a question on StackOverflow instead: http://stackoverflow.com/questions/tagged/spacy -->
+<!-- Describe your issue here. Please keep in mind that the GitHub issue tracker is mostly intended for reports related to the spaCy code base and source, and for bugs and feature requests. If you're looking for help with your code, consider posting a question on Stack Overflow instead: http://stackoverflow.com/questions/tagged/spacy -->
 
 ## Your Environment
 <!-- Include details of your environment. If you're using spaCy 1.7+, you can also type `python -m spacy info --markdown` and copy-paste the result here.-->

.github/contributors/BramVanroy.md

@@ -0,0 +1,106 @@
+# spaCy contributor agreement
+
+This spaCy Contributor Agreement (**"SCA"**) is based on the
+[Oracle Contributor Agreement](http://www.oracle.com/technetwork/oca-405177.pdf).
+The SCA applies to any contribution that you make to any product or project
+managed by us (the **"project"**), and sets out the intellectual property rights
+you grant to us in the contributed materials. The term **"us"** shall mean
+[ExplosionAI UG (haftungsbeschränkt)](https://explosion.ai/legal). The term
+**"you"** shall mean the person or entity identified below.
+
+If you agree to be bound by these terms, fill in the information requested
+below and include the filled-in version with your first pull request, under the
+folder [`.github/contributors/`](/.github/contributors/). The name of the file
+should be your GitHub username, with the extension `.md`. For example, the user
+example_user would create the file `.github/contributors/example_user.md`.
+
+Read this agreement carefully before signing. These terms and conditions
+constitute a binding legal agreement.
+
+## Contributor Agreement
+
+1. The term "contribution" or "contributed materials" means any source code,
+object code, patch, tool, sample, graphic, specification, manual,
+documentation, or any other material posted or submitted by you to the project.
+
+2. With respect to any worldwide copyrights, or copyright applications and
+registrations, in your contribution:
+
+    * you hereby assign to us joint ownership, and to the extent that such
+    assignment is or becomes invalid, ineffective or unenforceable, you hereby
+    grant to us a perpetual, irrevocable, non-exclusive, worldwide, no-charge,
+    royalty-free, unrestricted license to exercise all rights under those
+    copyrights. This includes, at our option, the right to sublicense these same
+    rights to third parties through multiple levels of sublicensees or other
+    licensing arrangements;
+
+    * you agree that each of us can do all things in relation to your
+    contribution as if each of us were the sole owners, and if one of us makes
+    a derivative work of your contribution, the one who makes the derivative
+    work (or has it made will be the sole owner of that derivative work;
+
+    * you agree that you will not assert any moral rights in your contribution
+    against us, our licensees or transferees;
+
+    * you agree that we may register a copyright in your contribution and
+    exercise all ownership rights associated with it; and
+
+    * you agree that neither of us has any duty to consult with, obtain the
+    consent of, pay or render an accounting to the other for any use or
+    distribution of your contribution.
+
+3. With respect to any patents you own, or that you can license without payment
+to any third party, you hereby grant to us a perpetual, irrevocable,
+non-exclusive, worldwide, no-charge, royalty-free license to:
+
+    * make, have made, use, sell, offer to sell, import, and otherwise transfer
+    your contribution in whole or in part, alone or in combination with or
+    included in any product, work or materials arising out of the project to
+    which your contribution was submitted, and
+
+    * at our option, to sublicense these same rights to third parties through
+    multiple levels of sublicensees or other licensing arrangements.
+
+4. Except as set out above, you keep all right, title, and interest in your
+contribution. The rights that you grant to us under these terms are effective
+on the date you first submitted a contribution to us, even if your submission
+took place before the date you sign these terms.
+
+5. You covenant, represent, warrant and agree that:
+
+    * Each contribution that you submit is and shall be an original work of
+    authorship and you can legally grant the rights set out in this SCA;
+
+    * to the best of your knowledge, each contribution will not violate any
+    third party's copyrights, trademarks, patents, or other intellectual
+    property rights; and
+
+    * each contribution shall be in compliance with U.S. export control laws and
+    other applicable export and import laws. You agree to notify us if you
+    become aware of any circumstance which would make any of the foregoing
+    representations inaccurate in any respect. We may publicly disclose your
+    participation in the project, including the fact that you have signed the SCA.
+
+6. This SCA is governed by the laws of the State of California and applicable
+U.S. Federal law. Any choice of law rules will not apply.
+
+7. Please place an “x” on one of the applicable statement below. Please do NOT
+mark both statements:
+
+    * [x] I am signing on behalf of myself as an individual and no other person
+    or entity, including my employer, has or will have rights with respect to my
+    contributions.
+
+    * [x] I am signing on behalf of my employer or a legal entity and I have the
+    actual authority to contractually bind that entity.
+
+## Contributor Details
+
+| Field                          | Entry                 |
+|------------------------------- | ----------------------|
+| Name                           | Bram Vanroy           |
+| Company name (if applicable)   |                       |
+| Title or role (if applicable)  |                       |
+| Date                           | October 19, 2018      |
+| GitHub username                | BramVanroy            |
+| Website (optional)             | https://bramvanroy.be |

CONTRIBUTING.md

@@ -26,7 +26,7 @@ also check the [troubleshooting guide](https://spacy.io/usage/#troubleshooting)
 to see if your problem is already listed there.
 
 If you're looking for help with your code, consider posting a question on
-[StackOverflow](http://stackoverflow.com/questions/tagged/spacy) instead. If you
+[Stack Overflow](http://stackoverflow.com/questions/tagged/spacy) instead. If you
 tag it `spacy` and `python`, more people will see it and hopefully be able to
 help. Please understand that we won't be able to provide individual support via
 email. We also believe that help is much more valuable if it's **shared publicly**,

README.rst

@@ -73,12 +73,12 @@ valuable if it's shared publicly, so that more people can benefit from it.
 
 ====================== ===
 **Bug Reports**        `GitHub Issue Tracker`_
-**Usage Questions**    `StackOverflow`_, `Gitter Chat`_, `Reddit User Group`_
+**Usage Questions**    `Stack Overflow`_, `Gitter Chat`_, `Reddit User Group`_
 **General Discussion** `Gitter Chat`_, `Reddit User Group`_
 ====================== ===
 
 .. _GitHub Issue Tracker: https://github.com/explosion/spaCy/issues
-.. _StackOverflow: http://stackoverflow.com/questions/tagged/spacy
+.. _Stack Overflow: http://stackoverflow.com/questions/tagged/spacy
 .. _Gitter Chat: https://gitter.im/explosion/spaCy
 .. _Reddit User Group: https://www.reddit.com/r/spacynlp
 

spacy/errors.py

@@ -250,7 +250,9 @@ class Errors(object):
     E096 = ("Invalid object passed to displaCy: Can only visualize Doc or "
              "Span objects, or dicts if set to manual=True.")
     E097 = ("Can't merge non-disjoint spans. '{token}' is already part of tokens to merge")
-
+    E098 = ("Trying to set conflicting doc.ents: '{span1}' and '{span2}'. A token"
+            " can only be part of one entity, so make sure the entities you're "
+            "setting don't overlap.")
 
 @add_codes
 class TempErrors(object):

spacy/tests/doc/test_add_entities.py

@@ -3,6 +3,7 @@ from __future__ import unicode_literals
 
 from ...pipeline import EntityRecognizer
 from ..util import get_doc
+from ...tokens import Span
 
 import pytest
 
@@ -22,3 +23,13 @@ def test_doc_add_entities_set_ents_iob(en_vocab):
 
     doc.ents = [(doc.vocab.strings['WORD'], 0, 2)]
     assert [w.ent_iob_ for w in doc] == ['B', 'I', '', '']
+
+def test_add_overlapping_entities(en_vocab):
+    text = ["Louisiana", "Office", "of", "Conservation"]
+    doc = get_doc(en_vocab, text)
+    entity = Span(doc, 0, 4, label=391)
+    doc.ents = [entity]
+
+    new_entity = Span(doc, 0, 1, label=392)
+    with pytest.raises(ValueError):
+        doc.ents = list(doc.ents) + [new_entity]

spacy/tests/regression/test_issue242.py

@@ -17,9 +17,10 @@ def test_issue242(en_tokenizer):
     matcher.add('FOOD', None, *patterns)
 
     matches = [(ent_type, start, end) for ent_type, start, end in matcher(doc)]
-    doc.ents += tuple(matches)
     match1, match2 = matches
     assert match1[1] == 3
     assert match1[2] == 5
     assert match2[1] == 4
     assert match2[2] == 6
+
+    doc.ents += tuple([match2])

spacy/tokens/doc.pyx

@@ -458,6 +458,21 @@ cdef class Doc:
             #    prediction
             # 3. Test basic data-driven ORTH gazetteer
             # 4. Test more nuanced date and currency regex
+
+            tokens_in_ents = {}
+            cdef attr_t entity_type
+            cdef int ent_start, ent_end
+            for ent_info in ents:
+                entity_type, ent_start, ent_end = get_entity_info(ent_info)
+                for token_index in range(ent_start, ent_end):
+                    if token_index in tokens_in_ents.keys():
+                        raise ValueError(Errors.E098.format(
+                            span1=(tokens_in_ents[token_index][0],
+                                   tokens_in_ents[token_index][1],
+                                   self.vocab.strings[tokens_in_ents[token_index][2]]),
+                            span2=(ent_start, ent_end, self.vocab.strings[entity_type])))
+                    tokens_in_ents[token_index] = (ent_start, ent_end, entity_type)
+
             cdef int i
             for i in range(self.length):
                 self.c[i].ent_type = 0
@@ -465,15 +480,7 @@ cdef class Doc:
             cdef attr_t ent_type
             cdef int start, end
             for ent_info in ents:
-                if isinstance(ent_info, Span):
+                ent_type, start, end = get_entity_info(ent_info)
-                    ent_id = ent_info.ent_id
-                    ent_type = ent_info.label
-                    start = ent_info.start
-                    end = ent_info.end
-                elif len(ent_info) == 3:
-                    ent_type, start, end = ent_info
-                else:
-                    ent_id, ent_type, start, end = ent_info
                 if ent_type is None or ent_type < 0:
                     # Mark as O
                     for i in range(start, end):
@@ -1062,3 +1069,14 @@ def fix_attributes(doc, attributes):
             attributes[ENT_TYPE] = doc.vocab.strings[attributes['label']]
     if 'ent_type' in attributes:
         attributes[ENT_TYPE] = attributes['ent_type']
+
+def get_entity_info(ent_info):
+    if isinstance(ent_info, Span):
+        ent_type = ent_info.label
+        start = ent_info.start
+        end = ent_info.end
+    elif len(ent_info) == 3:
+        ent_type, start, end = ent_info
+    else:
+        ent_id, ent_type, start, end = ent_info
+    return ent_type, start, end

website/_harp.json

@@ -40,7 +40,7 @@
             },
             "Support": {
                 "Issue Tracker": "https://github.com/explosion/spaCy/issues",
-                "StackOverflow": "http://stackoverflow.com/questions/tagged/spacy",
+                "Stack Overflow": "http://stackoverflow.com/questions/tagged/spacy",
                 "Reddit Usergroup": "https://www.reddit.com/r/spacynlp/",
                 "Gitter Chat": "https://gitter.im/explosion/spaCy"
             },

website/usage/_adding-languages/_language-data.jade

@@ -183,7 +183,7 @@ p
 
     back be became because become becomes becoming been before beforehand behind
     being below beside besides between beyond both bottom but by
-    """).split())
+    """.split())
 
 +infobox("Important note")
     |  When adding stop words from an online source, always #[strong include the link]

website/usage/_spacy-101/_community-faq.jade

@@ -31,10 +31,10 @@ p
 
 +table(["Platform", "Purpose"])
     +row
-        +cell #[+a("https://stackoverflow.com/questions/tagged/spacy") StackOverflow]
+        +cell #[+a("https://stackoverflow.com/questions/tagged/spacy") Stack Overflow]
         +cell
             |  #[strong Usage questions] and everything related to problems with
-            |  your specific code. The StackOverflow community is much larger
+            |  your specific code. The Stack Overflow community is much larger
             |  than ours, so if your problem can be solved by others, you'll
             |  receive help much quicker.
 

website/usage/examples.jade

@@ -75,7 +75,7 @@ include ../_includes/_mixins
 
     p
         |  This example shows how to use multiple cores to process text using
-        |  spaCy and #[+a("https://pythonhosted.org/joblib/") Joblib]. We're
+        |  spaCy and #[+a("https://joblib.readthedocs.io/en/latest/") Joblib]. We're
         |  exporting part-of-speech-tagged, true-cased, (very roughly)
         |  sentence-separated text, with each "sentence" on a newline, and
         |  spaces between tokens. Data is loaded from the IMDB movie reviews