From 7b277661f6cc91765dbe8891b230bb0dd8bdb53f Mon Sep 17 00:00:00 2001 From: Adriane Boyd Date: Thu, 10 Dec 2020 13:32:10 +0100 Subject: [PATCH 01/12] Set version to v2.3.5 --- spacy/about.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spacy/about.py b/spacy/about.py index a748b4294..c4836769a 100644 --- a/spacy/about.py +++ b/spacy/about.py @@ -1,6 +1,6 @@ # fmt: off __title__ = "spacy" -__version__ = "2.3.4" +__version__ = "2.3.5" __release__ = True __download_url__ = "https://github.com/explosion/spacy-models/releases/download" __compatibility__ = "https://raw.githubusercontent.com/explosion/spacy-models/master/compatibility.json" From 27bb75e2a07ca8ccaa5757340864beb9655fc541 Mon Sep 17 00:00:00 2001 From: Adriane Boyd Date: Thu, 10 Dec 2020 15:34:34 +0100 Subject: [PATCH 02/12] Docs and extras updates for v2.3.5 * Update install instructions for updated packages * Add `cuda110` and `cuda111` extras, remove upper `cupy` pins (only compatible with `thinc>=7.4.4`) --- README.md | 40 +++++++----- setup.cfg | 20 +++--- website/docs/usage/index.md | 75 ++++++++++++++++++----- website/src/widgets/quickstart-install.js | 19 +++--- 4 files changed, 106 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index e488bc117..de779b006 100644 --- a/README.md +++ b/README.md @@ -111,16 +111,16 @@ For detailed installation instructions, see the Using pip, spaCy releases are available as source packages and binary wheels (as of `v2.0.13`). Before you install spaCy and its dependencies, make sure that -`pip` and `setuptools` are up to date. +`pip`, `setuptools` and `wheel` are up to date. ```bash -pip install -U pip setuptools +pip install -U pip setuptools wheel pip install spacy ``` -For installation on python 3.5 where binary wheels are not provided for the most -recent versions of the dependencies, you can prefer older binary wheels over -newer source packages with `--prefer-binary`: +For installation on python 2.7 or 3.5 where binary wheels are not provided for +the most recent versions of the dependencies, you can prefer older binary +wheels over newer source packages with `--prefer-binary`: ```bash pip install spacy --prefer-binary @@ -140,6 +140,7 @@ environment to avoid modifying system state: ```bash python -m venv .env source .env/bin/activate +pip install -U pip setuptools wheel pip install spacy ``` @@ -238,16 +239,28 @@ do that depends on your system. See notes on Ubuntu, OS X and Windows for details. ```bash -# make sure you are using the latest pip -python -m pip install -U pip git clone https://github.com/explosion/spaCy cd spaCy python -m venv .env source .env/bin/activate -export PYTHONPATH=`pwd` + +# make sure you are using the latest pip +python -m pip install -U pip setuptools wheel + +pip install . +``` + +To install with extras: + +```bash +pip install .[lookups,cuda102] +``` + +To install all dependencies required for development: + +```bash pip install -r requirements.txt -python setup.py build_ext --inplace ``` Compared to regular install via pip, [requirements.txt](requirements.txt) @@ -287,14 +300,13 @@ tests, you'll usually want to clone the repository and build spaCy from source. This will also install the required development dependencies and test utilities defined in the `requirements.txt`. -Alternatively, you can find out where spaCy is installed and run `pytest` on -that directory. Don't forget to also install the test utilities via spaCy's +Alternatively, you can run `pytest` on the tests from within the installed +`spacy` package. Don't forget to also install the test utilities via spaCy's `requirements.txt`: ```bash -python -c "import os; import spacy; print(os.path.dirname(spacy.__file__))" -pip install -r path/to/requirements.txt -python -m pytest +pip install -r requirements.txt +python -m pytest --pyargs spacy ``` See [the documentation](https://spacy.io/usage#tests) for more details and diff --git a/setup.cfg b/setup.cfg index ec0bddeab..3b38f0b3c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -63,21 +63,25 @@ install_requires = lookups = spacy_lookups_data>=0.3.2,<0.4.0 cuda = - cupy>=5.0.0b4,<8.0.0 + cupy>=5.0.0b4 cuda80 = - cupy-cuda80>=5.0.0b4,<8.0.0 + cupy-cuda80>=5.0.0b4 cuda90 = - cupy-cuda90>=5.0.0b4,<8.0.0 + cupy-cuda90>=5.0.0b4 cuda91 = - cupy-cuda91>=5.0.0b4,<8.0.0 + cupy-cuda91>=5.0.0b4 cuda92 = - cupy-cuda92>=5.0.0b4,<8.0.0 + cupy-cuda92>=5.0.0b4 cuda100 = - cupy-cuda100>=5.0.0b4,<8.0.0 + cupy-cuda100>=5.0.0b4 cuda101 = - cupy-cuda101>=5.0.0b4,<8.0.0 + cupy-cuda101>=5.0.0b4 cuda102 = - cupy-cuda102>=5.0.0b4,<8.0.0 + cupy-cuda102>=5.0.0b4 +cuda110 = + cupy-cuda110>=5.0.0b4 +cuda111 = + cupy-cuda111>=5.0.0b4 # Language tokenizers with external dependencies ja = sudachipy>=0.4.5 diff --git a/website/docs/usage/index.md b/website/docs/usage/index.md index d0172104b..e5a37ad6c 100644 --- a/website/docs/usage/index.md +++ b/website/docs/usage/index.md @@ -31,9 +31,10 @@ import QuickstartInstall from 'widgets/quickstart-install.js' ### pip {#pip} Using pip, spaCy releases are available as source packages and binary wheels (as -of v2.0.13). +of v2.0.13). For the most recent releases, pip 19.3 or newer is recommended. ```bash +$ pip install -U pip setuptools wheel $ pip install -U spacy ``` @@ -66,6 +67,7 @@ environment to avoid modifying system state: ```bash python -m venv .env source .env/bin/activate +pip install -U pip setuptools wheel pip install spacy ``` @@ -122,10 +124,11 @@ support, we've been grateful to use the work of Chainer's interface for GPU arrays. spaCy can be installed on GPU by specifying `spacy[cuda]`, `spacy[cuda90]`, -`spacy[cuda91]`, `spacy[cuda92]`, `spacy[cuda100]`, `spacy[cuda101]` or -`spacy[cuda102]`. If you know your cuda version, using the more explicit -specifier allows cupy to be installed via wheel, saving some compilation time. -The specifiers should install [`cupy`](https://cupy.chainer.org). +`spacy[cuda91]`, `spacy[cuda92]`, `spacy[cuda100]`, `spacy[cuda101]`, +`spacy[cuda102]`, `spacy[cuda110]` or `spacy[cuda111]`. If you know your cuda +version, using the more explicit specifier allows cupy to be installed via +wheel, saving some compilation time. The specifiers should install +[`cupy`](https://cupy.chainer.org). ```bash $ pip install -U spacy[cuda92] @@ -158,15 +161,25 @@ system. See notes on [Ubuntu](#source-ubuntu), [macOS / OS X](#source-osx) and [Windows](#source-windows) for details. ```bash -python -m pip install -U pip # update pip git clone https://github.com/explosion/spaCy # clone spaCy cd spaCy # navigate into directory python -m venv .env # create environment in .env source .env/bin/activate # activate virtual environment -\export PYTHONPATH=`pwd` # set Python path to spaCy directory -pip install -r requirements.txt # install all requirements -python setup.py build_ext --inplace # compile spaCy +python -m pip install -U pip setuptools wheel # update build tools +pip install . # compile and install spaCy +``` + +To install with extras: + +```bash +pip install .[lookups,cuda102] # install spaCy with extras +``` + +To install all dependencies required for development: + +```bash +pip install -r requirements.txt ``` Compared to regular install via pip, the @@ -204,6 +217,36 @@ official distributions these are: | Python 3.4 | Visual Studio 2010 | | Python 3.5+ | Visual Studio 2015 | +#### Additional options for developers {#source-developers} + +Some additional options may be useful for spaCy developers who are editing the +source code and recompiling frequently. + +- Install in editable mode. Changes to `.py` files will be reflected as soon as + the files are saved, but edits to Cython files (`.pxd`, `.pyx`) will require + the `pip install` or `python setup.py build_ext` command below to be run + again. Before installing in editable mode, be sure you have removed any + previous installs with `pip uninstall spacy`, which you may need to run + multiple times to remove all traces of earlier installs. + + ```diff + pip install -U pip setuptools wheel + - pip install . + + pip install -r requirements.txt + + pip install --no-build-isolation --editable . + ``` + +- Build in parallel using `N` CPUs to speed up compilation and then install in + editable mode: + + ```diff + pip install -U pip setuptools wheel + - pip install . + + pip install -r requirements.txt + + python setup.py build_ext --inplace -j N + + python setup.py develop + ``` + ### Run tests {#run-tests} spaCy comes with an @@ -213,14 +256,12 @@ In order to run the tests, you'll usually want to clone the [build spaCy from source](#source). This will also install the required development dependencies and test utilities defined in the `requirements.txt`. -Alternatively, you can find out where spaCy is installed and run `pytest` on -that directory. Don't forget to also install the test utilities via spaCy's -[`requirements.txt`](https://github.com/explosion/spaCy/tree/master/requirements.txt): +Alternatively, you can run `pytest` on the tests packaged with the install +`spacy package. Don't forget to also install the test utilities via spaCy's [`requirements.txt`](https://github.com/explosion/spaCy/tree/master/requirements.txt): ```bash -python -c "import os; import spacy; print(os.path.dirname(spacy.__file__))" -pip install -r path/to/requirements.txt -python -m pytest [spacy directory] +pip install -r requirements.txt +python -m pytest --pyargs spacy ``` Calling `pytest` on the spaCy directory will run only the basic tests. The flag @@ -230,8 +271,8 @@ Calling `pytest` on the spaCy directory will run only the basic tests. The flag # make sure you are using recent pytest version python -m pip install -U pytest -python -m pytest [spacy directory] # basic tests -python -m pytest [spacy directory] --slow # basic and slow tests +python -m pytest --pyargs spacy # basic tests +python -m pytest --pyargs spacy --slow # basic and slow tests ``` ## Troubleshooting guide {#troubleshooting} diff --git a/website/src/widgets/quickstart-install.js b/website/src/widgets/quickstart-install.js index d32062627..e2da49f7e 100644 --- a/website/src/widgets/quickstart-install.js +++ b/website/src/widgets/quickstart-install.js @@ -88,17 +88,15 @@ const QuickstartInstall = ({ id, title }) => ( .env\Scripts\activate - pip install -U spacy + + pip install -U pip setuptools wheel + + + pip install -U spacy + conda install -c conda-forge spacy git clone https://github.com/{repo} cd spaCy - - export PYTHONPATH=`pwd` - - - set PYTHONPATH=/path/to/spaCy - - pip install -r requirements.txt pip install -U spacy-lookups-data @@ -108,7 +106,10 @@ const QuickstartInstall = ({ id, title }) => ( conda install -c conda-forge spacy-lookups-data - python setup.py build_ext --inplace + + pip install -U pip setuptools wheel + + pip install . {models.map(({ code, models: modelOptions }) => ( python -m spacy download {modelOptions[0]} From 52cdb12d26a42f58bdf8d1f89266dc3902a14147 Mon Sep 17 00:00:00 2001 From: svlandeg Date: Thu, 10 Dec 2020 19:58:43 +0100 Subject: [PATCH 03/12] add GH discussions to readme --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e488bc117..597ec0931 100644 --- a/README.md +++ b/README.md @@ -61,14 +61,15 @@ be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly, so that more people can benefit from it. -| Type | Platforms | -| ------------------------ | ------------------------------------------------------ | -| ๐Ÿšจ **Bug Reports** | [GitHub Issue Tracker] | -| ๐ŸŽ **Feature Requests** | [GitHub Issue Tracker] | -| ๐Ÿ‘ฉโ€๐Ÿ’ป **Usage Questions** | [Stack Overflow] ยท [Gitter Chat] ยท [Reddit User Group] | -| ๐Ÿ—ฏ **General Discussion** | [Gitter Chat] ยท [Reddit User Group] | +| Type | Platforms | +| ------------------------ | ----------------------------------------------------------------------------- | +| ๐Ÿšจ **Bug Reports** | [GitHub Issue Tracker] | +| ๐ŸŽ **Feature Requests** | [GitHub Discussions] | +| ๐Ÿ‘ฉโ€๐Ÿ’ป **Usage Questions** | [GitHub Discussions] ยท [Stack Overflow] ยท [Gitter Chat] ยท [Reddit User Group] | +| ๐Ÿ—ฏ **General Discussion** | [GitHub Discussions] ยท [Gitter Chat] ยท [Reddit User Group] | [github issue tracker]: https://github.com/explosion/spaCy/issues +[github discussions]: https://github.com/explosion/spaCy/discussions [stack overflow]: https://stackoverflow.com/questions/tagged/spacy [gitter chat]: https://gitter.im/explosion/spaCy [reddit user group]: https://www.reddit.com/r/spacynlp From ae1ccf2b04385aee002c5e71b0571165dd420183 Mon Sep 17 00:00:00 2001 From: svlandeg Date: Thu, 10 Dec 2020 20:02:49 +0100 Subject: [PATCH 04/12] update link to discussion forum --- website/UNIVERSE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/UNIVERSE.md b/website/UNIVERSE.md index 2a83b2983..d37c4561a 100644 --- a/website/UNIVERSE.md +++ b/website/UNIVERSE.md @@ -11,8 +11,8 @@ suggest it by submitting a pull request to this repository. The Universe database is open-source and collected in a simple JSON file. Looking for inspiration for your own spaCy plugin or extension? Check out the -[`project idea`](https://github.com/explosion/spaCy/labels/project%20idea) label -on the issue tracker. +[`project ideas`](https://github.com/explosion/spaCy/discussions?discussions_q=category%3A%22New+Features+%26+Project+Ideas%22) +discussion forum. ## Checklist From 5afa5677671569cd4ab5341c4680af2cddbbcfc1 Mon Sep 17 00:00:00 2001 From: svlandeg Date: Thu, 10 Dec 2020 20:17:36 +0100 Subject: [PATCH 05/12] replace gitter with discussions in 101 --- website/docs/usage/spacy-101.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/website/docs/usage/spacy-101.md b/website/docs/usage/spacy-101.md index 5a3a95a53..78ee127df 100644 --- a/website/docs/usage/spacy-101.md +++ b/website/docs/usage/spacy-101.md @@ -915,9 +915,10 @@ via the following platforms: questions** and everything related to problems with 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. -- [Gitter chat](https://gitter.im/explosion/spaCy): **General discussion** about - spaCy, meeting other community members and exchanging **tips, tricks and best - practices**. +- [GitHub discussions](https://github.com/explosion/spaCy/discussions): **General + discussion**, **project ideas** and **usage questions**. Meet other community + members to get help with a specific code implementation, discuss ideas for new + projects/plugins, support more languages, and share best practices. - [GitHub issue tracker](https://github.com/explosion/spaCy/issues): **Bug reports** and **improvement suggestions**, i.e. everything that's likely spaCy's fault. This also includes problems with the models beyond statistical From d156b423aeaf16e25ec103a8d4fee1f377c0deee Mon Sep 17 00:00:00 2001 From: svlandeg Date: Thu, 10 Dec 2020 20:41:02 +0100 Subject: [PATCH 06/12] remove gitter and reddit links --- README.md | 15 +++++++-------- website/meta/site.json | 2 +- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 597ec0931..d6fbd7f8a 100644 --- a/README.md +++ b/README.md @@ -61,18 +61,17 @@ be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly, so that more people can benefit from it. -| Type | Platforms | -| ------------------------ | ----------------------------------------------------------------------------- | -| ๐Ÿšจ **Bug Reports** | [GitHub Issue Tracker] | -| ๐ŸŽ **Feature Requests** | [GitHub Discussions] | -| ๐Ÿ‘ฉโ€๐Ÿ’ป **Usage Questions** | [GitHub Discussions] ยท [Stack Overflow] ยท [Gitter Chat] ยท [Reddit User Group] | -| ๐Ÿ—ฏ **General Discussion** | [GitHub Discussions] ยท [Gitter Chat] ยท [Reddit User Group] | +| Type | Platforms | +| ------------------------ | --------------------------------------- | +| ๐Ÿšจ **Bug Reports** | [GitHub Issue Tracker] | +| ๐ŸŽ **Feature Requests** | [GitHub Issue Tracker] | +| ๐ŸŽ **Project ideas** | [GitHub Discussions] | +| ๐Ÿ‘ฉโ€๐Ÿ’ป **Usage Questions** | [GitHub Discussions] ยท [Stack Overflow] | +| ๐Ÿ—ฏ **General Discussion** | [GitHub Discussions] | [github issue tracker]: https://github.com/explosion/spaCy/issues [github discussions]: https://github.com/explosion/spaCy/discussions [stack overflow]: https://stackoverflow.com/questions/tagged/spacy -[gitter chat]: https://gitter.im/explosion/spaCy -[reddit user group]: https://www.reddit.com/r/spacynlp ## Features diff --git a/website/meta/site.json b/website/meta/site.json index 31f2f2f68..7f9366b1d 100644 --- a/website/meta/site.json +++ b/website/meta/site.json @@ -51,12 +51,12 @@ { "label": "Support", "items": [ + { "text": "Github Discussions", "url": "https://github.com/explosion/spaCy/discussions" }, { "text": "Issue Tracker", "url": "https://github.com/explosion/spaCy/issues" }, { "text": "Stack Overflow", "url": "http://stackoverflow.com/questions/tagged/spacy" }, - { "text": "Reddit User Group", "url": "https://www.reddit.com/r/spacynlp/" }, { "text": "Gitter Chat", "url": "https://gitter.im/explosion/spaCy" } ] }, From 4afcd9567e6883e2a5d30be17ddfbd38c121c701 Mon Sep 17 00:00:00 2001 From: svlandeg Date: Thu, 10 Dec 2020 20:56:12 +0100 Subject: [PATCH 07/12] refer to GH discussions --- .github/ISSUE_TEMPLATE/03_request.md | 2 +- .github/ISSUE_TEMPLATE/05_other.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/03_request.md b/.github/ISSUE_TEMPLATE/03_request.md index 0b64aadd2..d48409ec3 100644 --- a/.github/ISSUE_TEMPLATE/03_request.md +++ b/.github/ISSUE_TEMPLATE/03_request.md @@ -1,6 +1,6 @@ --- name: "\U0001F381 Feature Request" -about: Do you have an idea for an improvement, a new feature or a plugin? +about: Do you have an idea for an improvement to the core library? Note that project ideas or plugins should be posted at GH Discussions instead. --- diff --git a/.github/ISSUE_TEMPLATE/05_other.md b/.github/ISSUE_TEMPLATE/05_other.md index 9aa04d161..446c3e400 100644 --- a/.github/ISSUE_TEMPLATE/05_other.md +++ b/.github/ISSUE_TEMPLATE/05_other.md @@ -1,7 +1,7 @@ --- name: "\U0001F4AC Anything else?" about: For general usage questions or help with your code, please consider - posting on Stack Overflow instead. + posting on Stack Overflow or GH Discussions instead. --- From 73896fcbc85c616842dd5038831bc5362fda9c0a Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Fri, 11 Dec 2020 10:05:19 +1100 Subject: [PATCH 08/12] Update README.md --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d6fbd7f8a..4b5f87cff 100644 --- a/README.md +++ b/README.md @@ -61,13 +61,12 @@ be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly, so that more people can benefit from it. -| Type | Platforms | -| ------------------------ | --------------------------------------- | -| ๐Ÿšจ **Bug Reports** | [GitHub Issue Tracker] | -| ๐ŸŽ **Feature Requests** | [GitHub Issue Tracker] | -| ๐ŸŽ **Project ideas** | [GitHub Discussions] | -| ๐Ÿ‘ฉโ€๐Ÿ’ป **Usage Questions** | [GitHub Discussions] ยท [Stack Overflow] | -| ๐Ÿ—ฏ **General Discussion** | [GitHub Discussions] | +| Type | Platforms | +| ------------------------------- | --------------------------------------- | +| ๐Ÿšจ **Bug Reports** | [GitHub Issue Tracker] | +| ๐ŸŽ **Feature Requests & Ideas** | [GitHub Discussions] | +| ๐Ÿ‘ฉโ€๐Ÿ’ป **Usage Questions** | [GitHub Discussions] ยท [Stack Overflow] | +| ๐Ÿ—ฏ **General Discussion** | [GitHub Discussions] | [github issue tracker]: https://github.com/explosion/spaCy/issues [github discussions]: https://github.com/explosion/spaCy/discussions From 43a69eecb7142e3b74f0415b2d843166977e3fe4 Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Fri, 11 Dec 2020 10:05:21 +1100 Subject: [PATCH 09/12] Update site.json --- website/meta/site.json | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/website/meta/site.json b/website/meta/site.json index 7f9366b1d..692c84505 100644 --- a/website/meta/site.json +++ b/website/meta/site.json @@ -44,20 +44,23 @@ "items": [ { "text": "Usage", "url": "/usage" }, { "text": "Models", "url": "/models" }, - { "text": "API", "url": "/api" }, - { "text": "Universe", "url": "/universe" } + { "text": "API Reference", "url": "/api" }, + { "text": "Online Course", "url": "https://course.spacy.io" } ] }, { - "label": "Support", + "label": "Community", "items": [ - { "text": "Github Discussions", "url": "https://github.com/explosion/spaCy/discussions" }, + { "text": "Universe", "url": "/universe" }, + { + "text": "Github Discussions", + "url": "https://github.com/explosion/spaCy/discussions" + }, { "text": "Issue Tracker", "url": "https://github.com/explosion/spaCy/issues" }, { "text": "Stack Overflow", "url": "http://stackoverflow.com/questions/tagged/spacy" - }, - { "text": "Gitter Chat", "url": "https://gitter.im/explosion/spaCy" } + } ] }, { From c9b67b02f89a0e193eae7ffff172c406ab739e88 Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Fri, 11 Dec 2020 10:05:47 +1100 Subject: [PATCH 10/12] Update issue templates --- .../ISSUE_TEMPLATE/{04_docs.md => 03_docs.md} | 0 .github/ISSUE_TEMPLATE/03_request.md | 11 ----------- .github/ISSUE_TEMPLATE/04_other.md | 19 +++++++++++++++++++ .github/ISSUE_TEMPLATE/05_other.md | 15 --------------- 4 files changed, 19 insertions(+), 26 deletions(-) rename .github/ISSUE_TEMPLATE/{04_docs.md => 03_docs.md} (100%) delete mode 100644 .github/ISSUE_TEMPLATE/03_request.md create mode 100644 .github/ISSUE_TEMPLATE/04_other.md delete mode 100644 .github/ISSUE_TEMPLATE/05_other.md diff --git a/.github/ISSUE_TEMPLATE/04_docs.md b/.github/ISSUE_TEMPLATE/03_docs.md similarity index 100% rename from .github/ISSUE_TEMPLATE/04_docs.md rename to .github/ISSUE_TEMPLATE/03_docs.md diff --git a/.github/ISSUE_TEMPLATE/03_request.md b/.github/ISSUE_TEMPLATE/03_request.md deleted file mode 100644 index d48409ec3..000000000 --- a/.github/ISSUE_TEMPLATE/03_request.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: "\U0001F381 Feature Request" -about: Do you have an idea for an improvement to the core library? Note that project ideas or plugins should be posted at GH Discussions instead. - ---- - -## Feature description - - -## Could the feature be a [custom component](https://spacy.io/usage/processing-pipelines#custom-components) or [spaCy plugin](https://spacy.io/universe)? -If so, we will tag it as [`project idea`](https://github.com/explosion/spaCy/labels/project%20idea) so other users can take it on. diff --git a/.github/ISSUE_TEMPLATE/04_other.md b/.github/ISSUE_TEMPLATE/04_other.md new file mode 100644 index 000000000..4c6ada4cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04_other.md @@ -0,0 +1,19 @@ +--- +name: "\U0001F4AC Anything else?" +about: For feature and project ideas, general usage questions or help with your code, please post on the GitHub Discussions board instead. +--- + + + +## Your Environment + + + +- Operating System: +- Python Version Used: +- spaCy Version Used: +- Environment Information: diff --git a/.github/ISSUE_TEMPLATE/05_other.md b/.github/ISSUE_TEMPLATE/05_other.md deleted file mode 100644 index 446c3e400..000000000 --- a/.github/ISSUE_TEMPLATE/05_other.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: "\U0001F4AC Anything else?" -about: For general usage questions or help with your code, please consider - posting on Stack Overflow or GH Discussions instead. - ---- - - - -## Your Environment - -* Operating System: -* Python Version Used: -* spaCy Version Used: -* Environment Information: From 76cfd89deafc6244ffa7eaf80fc4a4b574a575c7 Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Fri, 11 Dec 2020 10:19:42 +1100 Subject: [PATCH 11/12] Update site.json --- website/meta/site.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/meta/site.json b/website/meta/site.json index 692c84505..987099cba 100644 --- a/website/meta/site.json +++ b/website/meta/site.json @@ -53,7 +53,7 @@ "items": [ { "text": "Universe", "url": "/universe" }, { - "text": "Github Discussions", + "text": "GitHub Discussions", "url": "https://github.com/explosion/spaCy/discussions" }, { "text": "Issue Tracker", "url": "https://github.com/explosion/spaCy/issues" }, From 1d4b1dea25df6ab53521dc609d9b48a94385d1b0 Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Fri, 11 Dec 2020 13:39:26 +1100 Subject: [PATCH 12/12] Update contributing guide and issue template [ci skip] --- .github/ISSUE_TEMPLATE.md | 19 +++++++++++-------- CONTRIBUTING.md | 10 +++++----- 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 3597ea8d1..8b9677709 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,15 +1,18 @@ - +If you're looking for help with your code, consider posting a question here: +- GitHub Discussions: https://github.com/explosion/spaCy/discussions +- Stack Overflow: http://stackoverflow.com/questions/tagged/spacy +--> ## Your Environment - -* Operating System: -* Python Version Used: -* spaCy Version Used: -* Environment Information: + +- Operating System: +- Python Version Used: +- spaCy Version Used: +- Environment Information: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c2b56cd3..a0ffd0127 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,11 +26,11 @@ also often include helpful tips and solutions to common problems. You should 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 -[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**, +If you're looking for help with your code, consider posting a question on the +[GitHub Discussions board](https://github.com/explosion/spaCy/discussions) or +[Stack Overflow](http://stackoverflow.com/questions/tagged/spacy). 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**, so that more people can benefit from it. ### Submitting issues