mirror of
https://github.com/explosion/spaCy.git
synced 2024-11-11 12:18:04 +03:00
657af5f91f
* 🚨 Ignore all existing Mypy errors * 🏗 Add Mypy check to CI * Add types-mock and types-requests as dev requirements * Add additional type ignore directives * Add types packages to dev-only list in reqs test * Add types-dataclasses for python 3.6 * Add ignore to pretrain * 🏷 Improve type annotation on `run_command` helper The `run_command` helper previously declared that it returned an `Optional[subprocess.CompletedProcess]`, but it isn't actually possible for the function to return `None`. These changes modify the type annotation of the `run_command` helper and remove all now-unnecessary `# type: ignore` directives. * 🔧 Allow variable type redefinition in limited contexts These changes modify how Mypy is configured to allow variables to have their type automatically redefined under certain conditions. The Mypy documentation contains the following example: ```python def process(items: List[str]) -> None: # 'items' has type List[str] items = [item.split() for item in items] # 'items' now has type List[List[str]] ... ``` This configuration change is especially helpful in reducing the number of `# type: ignore` directives needed to handle the common pattern of: * Accepting a filepath as a string * Overwriting the variable using `filepath = ensure_path(filepath)` These changes enable redefinition and remove all `# type: ignore` directives rendered redundant by this change. * 🏷 Add type annotation to converters mapping * 🚨 Fix Mypy error in convert CLI argument verification * 🏷 Improve type annotation on `resolve_dot_names` helper * 🏷 Add type annotations for `Vocab` attributes `strings` and `vectors` * 🏷 Add type annotations for more `Vocab` attributes * 🏷 Add loose type annotation for gold data compilation * 🏷 Improve `_format_labels` type annotation * 🏷 Fix `get_lang_class` type annotation * 🏷 Loosen return type of `Language.evaluate` * 🏷 Don't accept `Scorer` in `handle_scores_per_type` * 🏷 Add `string_to_list` overloads * 🏷 Fix non-Optional command-line options * 🙈 Ignore redefinition of `wandb_logger` in `loggers.py` * ➕ Install `typing_extensions` in Python 3.8+ The `typing_extensions` package states that it should be used when "writing code that must be compatible with multiple Python versions". Since SpaCy needs to support multiple Python versions, it should be used when newer `typing` module members are required. One example of this is `Literal`, which is available starting with Python 3.8. Previously SpaCy tried to import `Literal` from `typing`, falling back to `typing_extensions` if the import failed. However, Mypy doesn't seem to be able to understand what `Literal` means when the initial import means. Therefore, these changes modify how `compat` imports `Literal` by always importing it from `typing_extensions`. These changes also modify how `typing_extensions` is installed, so that it is a requirement for all Python versions, including those greater than or equal to 3.8. * 🏷 Improve type annotation for `Language.pipe` These changes add a missing overload variant to the type signature of `Language.pipe`. Additionally, the type signature is enhanced to allow type checkers to differentiate between the two overload variants based on the `as_tuple` parameter. Fixes #8772 * ➖ Don't install `typing-extensions` in Python 3.8+ After more detailed analysis of how to implement Python version-specific type annotations using SpaCy, it has been determined that by branching on a comparison against `sys.version_info` can be statically analyzed by Mypy well enough to enable us to conditionally use `typing_extensions.Literal`. This means that we no longer need to install `typing_extensions` for Python versions greater than or equal to 3.8! 🎉 These changes revert previous changes installing `typing-extensions` regardless of Python version and modify how we import the `Literal` type to ensure that Mypy treats it properly. * resolve mypy errors for Strict pydantic types * refactor code to avoid missing return statement * fix types of convert CLI command * avoid list-set confustion in debug_data * fix typo and formatting * small fixes to avoid type ignores * fix types in profile CLI command and make it more efficient * type fixes in projects CLI * put one ignore back * type fixes for render * fix render types - the sequel * fix BaseDefault in language definitions * fix type of noun_chunks iterator - yields tuple instead of span * fix types in language-specific modules * 🏷 Expand accepted inputs of `get_string_id` `get_string_id` accepts either a string (in which case it returns its ID) or an ID (in which case it immediately returns the ID). These changes extend the type annotation of `get_string_id` to indicate that it can accept either strings or IDs. * 🏷 Handle override types in `combine_score_weights` The `combine_score_weights` function allows users to pass an `overrides` mapping to override data extracted from the `weights` argument. Since it allows `Optional` dictionary values, the return value may also include `Optional` dictionary values. These changes update the type annotations for `combine_score_weights` to reflect this fact. * 🏷 Fix tokenizer serialization method signatures in `DummyTokenizer` * 🏷 Fix redefinition of `wandb_logger` These changes fix the redefinition of `wandb_logger` by giving a separate name to each `WandbLogger` version. For backwards-compatibility, `spacy.train` still exports `wandb_logger_v3` as `wandb_logger` for now. * more fixes for typing in language * type fixes in model definitions * 🏷 Annotate `_RandomWords.probs` as `NDArray` * 🏷 Annotate `tok2vec` layers to help Mypy * 🐛 Fix `_RandomWords.probs` type annotations for Python 3.6 Also remove an import that I forgot to move to the top of the module 😅 * more fixes for matchers and other pipeline components * quick fix for entity linker * fixing types for spancat, textcat, etc * bugfix for tok2vec * type annotations for scorer * add runtime_checkable for Protocol * type and import fixes in tests * mypy fixes for training utilities * few fixes in util * fix import * 🐵 Remove unused `# type: ignore` directives * 🏷 Annotate `Language._components` * 🏷 Annotate `spacy.pipeline.Pipe` * add doc as property to span.pyi * small fixes and cleanup * explicit type annotations instead of via comment Co-authored-by: Adriane Boyd <adrianeboyd@gmail.com> Co-authored-by: svlandeg <sofie.vanlandeghem@gmail.com> Co-authored-by: svlandeg <svlandeg@github.com>
107 lines
5.2 KiB
Markdown
107 lines
5.2 KiB
Markdown
# 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 | Connor Brinton |
|
|
| Company name (if applicable) | |
|
|
| Title or role (if applicable) | |
|
|
| Date | July 20th, 2021 |
|
|
| GitHub username | connorbrinton |
|
|
| Website (optional) | |
|