mirror of
				https://github.com/explosion/spaCy.git
				synced 2025-11-04 09:57:26 +03:00 
			
		
		
		
	Bugfix/fix entity ruler from disk (#4670)
* fix EntityRuler from_disk bug * add contributor file * Test EntityRuler PhraseMatcher deserialization (#4651) * newline at end of file * fix copy paste error * serializing the EntityRuler by itself * Add unicode declarations for Python 2 and auto-format
This commit is contained in:
		
							parent
							
								
									054df5d90a
								
							
						
					
					
						commit
						8f7ab70870
					
				
							
								
								
									
										106
									
								
								.github/contributors/GuiGel.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										106
									
								
								.github/contributors/GuiGel.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -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 GmbH](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.
 | 
			
		||||
 | 
			
		||||
    * [ ] 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                           | Guillaume Gelabert   |
 | 
			
		||||
| Company name (if applicable)   |                      |
 | 
			
		||||
| Title or role (if applicable)  |                      |
 | 
			
		||||
| Date                           | 2019-11-15           |
 | 
			
		||||
| GitHub username                | GuiGel               |
 | 
			
		||||
| Website (optional)             |                      |
 | 
			
		||||
| 
						 | 
				
			
			@ -292,13 +292,14 @@ class EntityRuler(object):
 | 
			
		|||
            self.add_patterns(patterns)
 | 
			
		||||
        else:
 | 
			
		||||
            cfg = {}
 | 
			
		||||
            deserializers = {
 | 
			
		||||
            deserializers_patterns = {
 | 
			
		||||
                "patterns": lambda p: self.add_patterns(
 | 
			
		||||
                    srsly.read_jsonl(p.with_suffix(".jsonl"))
 | 
			
		||||
                ),
 | 
			
		||||
                "cfg": lambda p: cfg.update(srsly.read_json(p)),
 | 
			
		||||
                )}
 | 
			
		||||
            deserializers_cfg = {
 | 
			
		||||
                "cfg": lambda p: cfg.update(srsly.read_json(p))
 | 
			
		||||
            }
 | 
			
		||||
            from_disk(path, deserializers, {})
 | 
			
		||||
            from_disk(path, deserializers_cfg, {})
 | 
			
		||||
            self.overwrite = cfg.get("overwrite", False)
 | 
			
		||||
            self.phrase_matcher_attr = cfg.get("phrase_matcher_attr")
 | 
			
		||||
            self.ent_id_sep = cfg.get("ent_id_sep", DEFAULT_ENT_ID_SEP)
 | 
			
		||||
| 
						 | 
				
			
			@ -307,6 +308,7 @@ class EntityRuler(object):
 | 
			
		|||
                self.phrase_matcher = PhraseMatcher(
 | 
			
		||||
                    self.nlp.vocab, attr=self.phrase_matcher_attr
 | 
			
		||||
                )
 | 
			
		||||
            from_disk(path, deserializers_patterns, {})
 | 
			
		||||
        return self
 | 
			
		||||
 | 
			
		||||
    def to_disk(self, path, **kwargs):
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										64
									
								
								spacy/tests/regression/test_issue4651.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										64
									
								
								spacy/tests/regression/test_issue4651.py
									
									
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,64 @@
 | 
			
		|||
# coding: utf-8
 | 
			
		||||
from __future__ import unicode_literals
 | 
			
		||||
 | 
			
		||||
from spacy.lang.en import English
 | 
			
		||||
from spacy.pipeline import EntityRuler
 | 
			
		||||
from spacy.tests.util import make_tempdir
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def test_issue4651_with_phrase_matcher_attr():
 | 
			
		||||
    """Test that the EntityRuler PhraseMatcher is deserialize correctly using
 | 
			
		||||
    the method from_disk when the EntityRuler argument phrase_matcher_attr is
 | 
			
		||||
    specified.
 | 
			
		||||
    """
 | 
			
		||||
    text = "Spacy is a python library for nlp"
 | 
			
		||||
 | 
			
		||||
    nlp = English()
 | 
			
		||||
    ruler = EntityRuler(nlp, phrase_matcher_attr="LOWER")
 | 
			
		||||
    patterns = [{"label": "PYTHON_LIB", "pattern": "spacy", "id": "spaCy"}]
 | 
			
		||||
    ruler.add_patterns(patterns)
 | 
			
		||||
    nlp.add_pipe(ruler)
 | 
			
		||||
 | 
			
		||||
    doc = nlp(text)
 | 
			
		||||
    res = [(ent.text, ent.label_, ent.ent_id_) for ent in doc.ents]
 | 
			
		||||
 | 
			
		||||
    nlp_reloaded = English()
 | 
			
		||||
    with make_tempdir() as d:
 | 
			
		||||
        file_path = d / "entityruler"
 | 
			
		||||
        ruler.to_disk(file_path)
 | 
			
		||||
        ruler_reloaded = EntityRuler(nlp_reloaded).from_disk(file_path)
 | 
			
		||||
 | 
			
		||||
    nlp_reloaded.add_pipe(ruler_reloaded)
 | 
			
		||||
    doc_reloaded = nlp_reloaded(text)
 | 
			
		||||
    res_reloaded = [(ent.text, ent.label_, ent.ent_id_) for ent in doc_reloaded.ents]
 | 
			
		||||
 | 
			
		||||
    assert res == res_reloaded
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def test_issue4651_without_phrase_matcher_attr():
 | 
			
		||||
    """Test that the EntityRuler PhraseMatcher is deserialize correctly using
 | 
			
		||||
    the method from_disk when the EntityRuler argument phrase_matcher_attr is
 | 
			
		||||
    not specified.
 | 
			
		||||
    """
 | 
			
		||||
    text = "Spacy is a python library for nlp"
 | 
			
		||||
 | 
			
		||||
    nlp = English()
 | 
			
		||||
    ruler = EntityRuler(nlp)
 | 
			
		||||
    patterns = [{"label": "PYTHON_LIB", "pattern": "spacy", "id": "spaCy"}]
 | 
			
		||||
    ruler.add_patterns(patterns)
 | 
			
		||||
    nlp.add_pipe(ruler)
 | 
			
		||||
 | 
			
		||||
    doc = nlp(text)
 | 
			
		||||
    res = [(ent.text, ent.label_, ent.ent_id_) for ent in doc.ents]
 | 
			
		||||
 | 
			
		||||
    nlp_reloaded = English()
 | 
			
		||||
    with make_tempdir() as d:
 | 
			
		||||
        file_path = d / "entityruler"
 | 
			
		||||
        ruler.to_disk(file_path)
 | 
			
		||||
        ruler_reloaded = EntityRuler(nlp_reloaded).from_disk(file_path)
 | 
			
		||||
 | 
			
		||||
    nlp_reloaded.add_pipe(ruler_reloaded)
 | 
			
		||||
    doc_reloaded = nlp_reloaded(text)
 | 
			
		||||
    res_reloaded = [(ent.text, ent.label_, ent.ent_id_) for ent in doc_reloaded.ents]
 | 
			
		||||
 | 
			
		||||
    assert res == res_reloaded
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user