mirror of
https://github.com/explosion/spaCy.git
synced 2024-11-14 05:37:03 +03:00
Add spaCy VSCode extension materials (#12592)
This commit is contained in:
parent
95fd46b1dd
commit
6930a6bf45
|
@ -36,7 +36,7 @@ open-source software, released under the [MIT license](https://github.com/explos
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
| Documentation | |
|
| Documentation | |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------- | ---------------------------------------------------------------------- |
|
||||||
| ⭐️ **[spaCy 101]** | New to spaCy? Here's everything you need to know! |
|
| ⭐️ **[spaCy 101]** | New to spaCy? Here's everything you need to know! |
|
||||||
| 📚 **[Usage Guides]** | How to use spaCy and its features. |
|
| 📚 **[Usage Guides]** | How to use spaCy and its features. |
|
||||||
| 🚀 **[New in v3.0]** | New features, backwards incompatibilities and migration guide. |
|
| 🚀 **[New in v3.0]** | New features, backwards incompatibilities and migration guide. |
|
||||||
|
@ -44,6 +44,7 @@ open-source software, released under the [MIT license](https://github.com/explos
|
||||||
| 🎛 **[API Reference]** | The detailed reference for spaCy's API. |
|
| 🎛 **[API Reference]** | The detailed reference for spaCy's API. |
|
||||||
| 📦 **[Models]** | Download trained pipelines for spaCy. |
|
| 📦 **[Models]** | Download trained pipelines for spaCy. |
|
||||||
| 🌌 **[Universe]** | Plugins, extensions, demos and books from the spaCy ecosystem. |
|
| 🌌 **[Universe]** | Plugins, extensions, demos and books from the spaCy ecosystem. |
|
||||||
|
| ⚙️ **[spaCy VS Code Extension]** | Additional tooling and features for working with spaCy's config files. |
|
||||||
| 👩🏫 **[Online Course]** | Learn spaCy in this free and interactive online course. |
|
| 👩🏫 **[Online Course]** | Learn spaCy in this free and interactive online course. |
|
||||||
| 📺 **[Videos]** | Our YouTube channel with video tutorials, talks and more. |
|
| 📺 **[Videos]** | Our YouTube channel with video tutorials, talks and more. |
|
||||||
| 🛠 **[Changelog]** | Changes and version history. |
|
| 🛠 **[Changelog]** | Changes and version history. |
|
||||||
|
@ -57,13 +58,13 @@ open-source software, released under the [MIT license](https://github.com/explos
|
||||||
[api reference]: https://spacy.io/api/
|
[api reference]: https://spacy.io/api/
|
||||||
[models]: https://spacy.io/models
|
[models]: https://spacy.io/models
|
||||||
[universe]: https://spacy.io/universe
|
[universe]: https://spacy.io/universe
|
||||||
|
[spaCy VS Code Extension]: https://github.com/explosion/spacy-vscode
|
||||||
[videos]: https://www.youtube.com/c/ExplosionAI
|
[videos]: https://www.youtube.com/c/ExplosionAI
|
||||||
[online course]: https://course.spacy.io
|
[online course]: https://course.spacy.io
|
||||||
[project templates]: https://github.com/explosion/projects
|
[project templates]: https://github.com/explosion/projects
|
||||||
[changelog]: https://spacy.io/usage#changelog
|
[changelog]: https://spacy.io/usage#changelog
|
||||||
[contribute]: https://github.com/explosion/spaCy/blob/master/CONTRIBUTING.md
|
[contribute]: https://github.com/explosion/spaCy/blob/master/CONTRIBUTING.md
|
||||||
|
|
||||||
|
|
||||||
## 💬 Where to ask questions
|
## 💬 Where to ask questions
|
||||||
|
|
||||||
The spaCy project is maintained by the [spaCy team](https://explosion.ai/about).
|
The spaCy project is maintained by the [spaCy team](https://explosion.ai/about).
|
||||||
|
|
|
@ -259,6 +259,26 @@ source code and recompiling frequently.
|
||||||
$ python setup.py develop
|
$ python setup.py develop
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Visual Studio Code extension
|
||||||
|
|
||||||
|
![spaCy extension demo](/images/spacy-extension-demo.gif)
|
||||||
|
|
||||||
|
The [spaCy VSCode Extension](https://github.com/explosion/spacy-vscode) provides
|
||||||
|
additional tooling and features for working with spaCy's config files. Version
|
||||||
|
1.0.0 includes hover descriptions for registry functions, variables, and section
|
||||||
|
names within the config as an installable extension.
|
||||||
|
|
||||||
|
1. Install a supported version of Python on your system (`>=3.7`)
|
||||||
|
2. Install the
|
||||||
|
[Python Extension for Visual Studio Code](https://code.visualstudio.com/docs/python/python-tutorial)
|
||||||
|
3. Create a
|
||||||
|
[virtual python environment](https://docs.python.org/3/library/venv.html)
|
||||||
|
4. Install all python requirements (`spaCy >= 3.4.0` & `pygls >= 1.0.0`)
|
||||||
|
5. Install
|
||||||
|
[spaCy extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Explosion.spacy-extension)
|
||||||
|
6. Select your python environment
|
||||||
|
7. You are ready to work with `.cfg` files in spaCy!
|
||||||
|
|
||||||
### Building an executable {id="executable"}
|
### Building an executable {id="executable"}
|
||||||
|
|
||||||
The spaCy repository includes a [`Makefile`](%%GITHUB_SPACY/Makefile) that
|
The spaCy repository includes a [`Makefile`](%%GITHUB_SPACY/Makefile) that
|
||||||
|
|
|
@ -1,5 +1,22 @@
|
||||||
{
|
{
|
||||||
"resources": [
|
"resources": [
|
||||||
|
{
|
||||||
|
"id": "spacy-vscode",
|
||||||
|
"title": "spaCy Visual Studio Code Extension",
|
||||||
|
"thumb": "https://raw.githubusercontent.com/explosion/spacy-vscode/main/icon.png",
|
||||||
|
"slogan": "Work with spaCy's config files in VS Code",
|
||||||
|
"description": "The spaCy VS Code Extension provides additional tooling and features for working with spaCy's config files. Version 1.0.0 includes hover descriptions for registry functions, variables, and section names within the config as an installable extension.",
|
||||||
|
"url": "https://marketplace.visualstudio.com/items?itemName=Explosion.spacy-extension",
|
||||||
|
"github": "explosion/spacy-vscode",
|
||||||
|
"code_language": "python",
|
||||||
|
"author": "Explosion",
|
||||||
|
"author_links": {
|
||||||
|
"twitter": "@explosion_ai",
|
||||||
|
"github": "explosion"
|
||||||
|
},
|
||||||
|
"category": ["extension"],
|
||||||
|
"tags": []
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"id": "parsigs",
|
"id": "parsigs",
|
||||||
"title": "parsigs",
|
"title": "parsigs",
|
||||||
|
|
BIN
website/public/images/spacy-extension-demo.gif
Normal file
BIN
website/public/images/spacy-extension-demo.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.4 MiB |
Loading…
Reference in New Issue
Block a user