diff --git a/.github/contributors/gavrieltal.md b/.github/contributors/gavrieltal.md new file mode 100644 index 000000000..16ed38131 --- /dev/null +++ b/.github/contributors/gavrieltal.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. + + * [] 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 | Gavriel Loria | +| Company name (if applicable) | | +| Title or role (if applicable) | | +| Date | Nov 29, 2018 | +| GitHub username | gavrieltal | +| Website (optional) | | diff --git a/spacy/errors.py b/spacy/errors.py index e1cc8a819..9c945fb0c 100644 --- a/spacy/errors.py +++ b/spacy/errors.py @@ -284,6 +284,9 @@ class Errors(object): E106 = ("Can't find doc._.{attr} attribute specified in the underscore " "settings: {opts}") E107 = ("Value of doc._.{attr} is not JSON-serializable: {value}") + E108 = ("As of spaCy v2.1, the pipe name `sbd` has been deprecated " + "in favor of the pipe name `sentencizer`, which does the same " + "thing. For example, use `nlp.create_pipeline('sentencizer')`") @add_codes diff --git a/spacy/language.py b/spacy/language.py index 092b02a24..f8afe84f7 100644 --- a/spacy/language.py +++ b/spacy/language.py @@ -116,7 +116,6 @@ class Language(object): "ner": lambda nlp, **cfg: EntityRecognizer(nlp.vocab, **cfg), "similarity": lambda nlp, **cfg: SimilarityHook(nlp.vocab, **cfg), "textcat": lambda nlp, **cfg: TextCategorizer(nlp.vocab, **cfg), - "sbd": lambda nlp, **cfg: SentenceSegmenter(nlp.vocab, **cfg), "sentencizer": lambda nlp, **cfg: SentenceSegmenter(nlp.vocab, **cfg), "merge_noun_chunks": lambda nlp, **cfg: merge_noun_chunks, "merge_entities": lambda nlp, **cfg: merge_entities, @@ -243,7 +242,10 @@ class Language(object): RETURNS (callable): Pipeline component. """ if name not in self.factories: - raise KeyError(Errors.E002.format(name=name)) + if name == "sbd": + raise KeyError(Errors.E108.format(name=name)) + else: + raise KeyError(Errors.E002.format(name=name)) factory = self.factories[name] return factory(self, **config) diff --git a/spacy/pipeline.pyx b/spacy/pipeline.pyx index e2a244080..62d958ef2 100644 --- a/spacy/pipeline.pyx +++ b/spacy/pipeline.pyx @@ -49,7 +49,7 @@ class SentenceSegmenter(object): Sentence detection strategies should be generators that take `Doc` objects and yield `Span` objects for each sentence. """ - name = 'sbd' + name = 'sentencizer' def __init__(self, vocab, strategy=None): self.vocab = vocab diff --git a/website/usage/_linguistic-features/_sentence-segmentation.jade b/website/usage/_linguistic-features/_sentence-segmentation.jade index c934e7259..0ec514195 100644 --- a/website/usage/_linguistic-features/_sentence-segmentation.jade +++ b/website/usage/_linguistic-features/_sentence-segmentation.jade @@ -88,8 +88,8 @@ p from spacy.lang.en import English nlp = English() # just the language with no model - sbd = nlp.create_pipe('sentencizer') # or: nlp.create_pipe('sbd') - nlp.add_pipe(sbd) + sentencizer = nlp.create_pipe('sentencizer') + nlp.add_pipe(sentencizer) doc = nlp(u"This is a sentence. This is another sentence.") for sent in doc.sents: print(sent.text) @@ -122,8 +122,8 @@ p yield doc[start:len(doc)] nlp = English() # just the language with no model - sbd = SentenceSegmenter(nlp.vocab, strategy=split_on_newlines) - nlp.add_pipe(sbd) + sentencizer = SentenceSegmenter(nlp.vocab, strategy=split_on_newlines) + nlp.add_pipe(sentencizer) doc = nlp(u"This is a sentence\n\nThis is another sentence\nAnd more") for sent in doc.sents: print([token.text for token in sent]) diff --git a/website/usage/_processing-pipelines/_extensions.jade b/website/usage/_processing-pipelines/_extensions.jade index 314ad7fe1..6bfdef543 100644 --- a/website/usage/_processing-pipelines/_extensions.jade +++ b/website/usage/_processing-pipelines/_extensions.jade @@ -144,7 +144,7 @@ p +code-exec. import spacy - def sbd_component(doc): + def custom_sentencizer(doc): for i, token in enumerate(doc[:-2]): # define sentence start if period + titlecase token if token.text == '.' and doc[i+1].is_title: @@ -152,7 +152,7 @@ p return doc nlp = spacy.load('en_core_web_sm') - nlp.add_pipe(sbd_component, before='parser') # insert before the parser + nlp.add_pipe(custom_sentencizer, before='parser') # insert before parser doc = nlp(u"This is a sentence. This is another sentence.") for sent in doc.sents: print(sent.text)