💫 Update website (#3285)
<!--- Provide a general summary of your changes in the title. -->
## Description
The new website is implemented using [Gatsby](https://www.gatsbyjs.org) with [Remark](https://github.com/remarkjs/remark) and [MDX](https://mdxjs.com/). This allows authoring content in **straightforward Markdown** without the usual limitations. Standard elements can be overwritten with powerful [React](http://reactjs.org/) components and wherever Markdown syntax isn't enough, JSX components can be used. Hopefully, this update will also make it much easier to contribute to the docs. Once this PR is merged, I'll implement auto-deployment via [Netlify](https://netlify.com) on a specific branch (to avoid building the website on every PR). There's a bunch of other cool stuff that the new setup will allow us to do – including writing front-end tests, service workers, offline support, implementing a search and so on.
This PR also includes various new docs pages and content.
Resolves #3270. Resolves #3222. Resolves #2947. Resolves #2837.
### Types of change
enhancement
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2019-02-17 18:31:19 +00:00
|
|
|
|
A named entity is a "real-world object" that's assigned a name – for example, a
|
|
|
|
|
|
person, a country, a product or a book title. spaCy can **recognize**
|
|
|
|
|
|
[various types](/api/annotation#named-entities) of named entities in a document,
|
|
|
|
|
|
by asking the model for a **prediction**. Because models are statistical and
|
|
|
|
|
|
strongly depend on the examples they were trained on, this doesn't always work
|
|
|
|
|
|
_perfectly_ and might need some tuning later, depending on your use case.
|
|
|
|
|
|
|
|
|
|
|
|
Named entities are available as the `ents` property of a `Doc`:
|
|
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
|
### {executable="true"}
|
|
|
|
|
|
import spacy
|
|
|
|
|
|
|
|
|
|
|
|
nlp = spacy.load("en_core_web_sm")
|
|
|
|
|
|
doc = nlp(u"Apple is looking at buying U.K. startup for $1 billion")
|
|
|
|
|
|
|
|
|
|
|
|
for ent in doc.ents:
|
|
|
|
|
|
print(ent.text, ent.start_char, ent.end_char, ent.label_)
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
> - **Text:** The original entity text.
|
|
|
|
|
|
> - **Start:** Index of start of entity in the `Doc`.
|
|
|
|
|
|
> - **End:** Index of end of entity in the `Doc`.
|
|
|
|
|
|
> - **LabeL:** Entity label, i.e. type.
|
|
|
|
|
|
|
|
|
|
|
|
| Text | Start | End | Label | Description |
|
|
|
|
|
|
| ----------- | :---: | :-: | ------- | ---------------------------------------------------- |
|
|
|
|
|
|
| Apple | 0 | 5 | `ORG` | Companies, agencies, institutions. |
|
|
|
|
|
|
| U.K. | 27 | 31 | `GPE` | Geopolitical entity, i.e. countries, cities, states. |
|
|
|
|
|
|
| \$1 billion | 44 | 54 | `MONEY` | Monetary values, including unit. |
|
|
|
|
|
|
|
|
|
|
|
|
Using spaCy's built-in [displaCy visualizer](/usage/visualizers), here's what
|
|
|
|
|
|
our example sentence and its named entities look like:
|
|
|
|
|
|
|
2019-08-18 14:29:29 +00:00
|
|
|
|
import DisplaCyEntHtml from 'images/displacy-ent1.html'; import { Iframe } from
|
💫 Update website (#3285)
<!--- Provide a general summary of your changes in the title. -->
## Description
The new website is implemented using [Gatsby](https://www.gatsbyjs.org) with [Remark](https://github.com/remarkjs/remark) and [MDX](https://mdxjs.com/). This allows authoring content in **straightforward Markdown** without the usual limitations. Standard elements can be overwritten with powerful [React](http://reactjs.org/) components and wherever Markdown syntax isn't enough, JSX components can be used. Hopefully, this update will also make it much easier to contribute to the docs. Once this PR is merged, I'll implement auto-deployment via [Netlify](https://netlify.com) on a specific branch (to avoid building the website on every PR). There's a bunch of other cool stuff that the new setup will allow us to do – including writing front-end tests, service workers, offline support, implementing a search and so on.
This PR also includes various new docs pages and content.
Resolves #3270. Resolves #3222. Resolves #2947. Resolves #2837.
### Types of change
enhancement
## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2019-02-17 18:31:19 +00:00
|
|
|
|
'components/embed'
|
|
|
|
|
|
|
2019-08-18 14:29:29 +00:00
|
|
|
|
<Iframe title="displaCy visualization of entities" html={DisplaCyEntHtml} height={100} />
|