Commit Graph

113 Commits

Author SHA1 Message Date
ines
d517dd4297 Document remove_extension methods 2018-07-21 15:51:28 +02:00
ines
153f41a5cc Use better examples for Doc extension methods 2018-07-21 15:51:11 +02:00
Nipun Sadvilkar
741ba80bd5 Train model command n_iteration 20 -> 30 (#2454)
In source code `train.py` default Number of iterations  is 30
2018-06-18 11:57:08 +02:00
Ines Montani
968f6f0bda
💫 Document Cython API (#2433)
## Description

This PR adds the most relevant documentation of spaCy's Cython API.

(Todo for when we publish this: rewrite `/api/#section-cython` and `/api/#cython` to `/api/cython#conventions`.)

### Types of change
docs

## 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.
2018-06-11 17:47:46 +02:00
himkt
1a568f2e08 fix wrong documentations (#2423) 2018-06-11 00:21:06 +02:00
Shantam Raj
1a4682dd0b Update _training.jade (#2340)
* Update _training.jade

Correcting grammar. Replacing "The" with "To".

* Create armsp.md

* Update armsp.md
2018-05-21 11:09:33 +02:00
ines
ff1082d8e4 Add version tag in CLI docs [ci skip] 2018-05-21 01:17:49 +02:00
Ines Montani
d4cc736b7c 💫 Improve model downloads: check for existing install, customise pip and use requests library again (#2346)
* Go back to using requests instead of urllib (closes #2320)

Fewer dependencies are good, but this one was simply causing too many other problems around SSL verification and Python 2/3 compatibility. requests is a popular enough package that it's okay for spaCy to depend on it – and this will hopefully make model downloads less flakey.

* Only download model if not installed (see #1456)

Use #egg=model==version to allow pip to check for existing installations. The download is only started if no installation matching the package/version is found. Fixes a long-standing inconvenience.

* Pass additional options to pip when installing model (resolves #1456)

Treat all additional arguments passed to the download command as pip options to allow user to customise the command. For example:

python -m spacy download en --user

* Add CLI option to enable installing model package dependencies

* Revert "Add CLI option to enable installing model package dependencies"

This reverts commit 9336ffe695.

* Update documentation
2018-05-20 20:26:56 +02:00
vishnumenon
ae3719ece5 Fix the code for FACILITIY entities (#2324)
* Fix the code for FACILITIY entities

As far as I can tell, the default models all use "FAC" rather than "FACILITY"

* Added my Contributor Agreement

* Rename vishnumenon to vishnumenon.md
2018-05-12 15:19:17 +02:00
Alex Villarreal
647f2544c5 Fix code sample for span.set_extension (#2286) 2018-05-03 00:39:22 +02:00
Alex Villarreal
13d562e1a4 Fix code sample for Doc.set_extension (#2282)
* Fix code sample for `set_extension`

The previous sample code for `set_extension` fails the assertion at the end, because `city_getter` it checked if the whole document text matches any of the city names. Now it checks if any of the city names is contained in the document text.

* Contributor agreement
2018-05-02 10:16:05 +02:00
Ines Montani
49cee4af92
💫 Interactive code examples, spaCy Universe and various docs improvements (#2274)
* Integrate Python kernel via Binder

* Add live model test for languages with examples

* Update docs and code examples

* Adjust margin (if not bootstrapped)

* Add binder version to global config

* Update terminal and executable code mixins

* Pass attributes through infobox and section

* Hide v-cloak

* Fix example

* Take out model comparison for now

* Add meta text for compat

* Remove chart.js dependency

* Tidy up and simplify JS and port big components over to Vue

* Remove chartjs example

* Add Twitter icon

* Add purple stylesheet option

* Add utility for hand cursor (special cases only)

* Add transition classes

* Add small option for section

* Add thumb object for small round thumbnail images

* Allow unset code block language via "none" value

(workaround to still allow unset language to default to DEFAULT_SYNTAX)

* Pass through attributes

* Add syntax highlighting definitions for Julia, R and Docker

* Add website icon

* Remove user survey from navigation

* Don't hide GitHub icon on small screens

* Make top navigation scrollable on small screens

* Remove old resources page and references to it

* Add Universe

* Add helper functions for better page URL and title

* Update site description

* Increment versions

* Update preview images

* Update mentions of resources

* Fix image

* Fix social images

* Fix problem with cover sizing and floats

* Add divider and move badges into heading

* Add docstrings

* Reference converting section

* Add section on converting word vectors

* Move converting section to custom section and fix formatting

* Remove old fastText example

* Move extensions content to own section

Keep weird ID to not break permalinks for now (we don't want to rewrite URLs if not absolutely necessary)

* Use better component example and add factories section

* Add note on larger model

* Use better example for non-vector

* Remove similarity in context section

Only works via small models with tensors so has always been kind of confusing

* Add note on init-model command

* Fix lightning tour examples and make excutable if possible

* Add spacy train CLI section to train

* Fix formatting and add video

* Fix formatting

* Fix textcat example description (resolves #2246)

* Add dummy file to try resolve conflict

* Delete dummy file

* Tidy up [ci skip]

* Ensure sufficient height of loading container

* Add loading animation to universe

* Update Thebelab build and use better startup message

* Fix asset versioning

* Fix typo [ci skip]

* Add note on project idea label
2018-04-29 02:06:46 +02:00
ines
a512fa60ef Remove upcoming option from docs for now 2018-04-28 23:32:18 +02:00
ines
6fb6371670 Add collapse_phrases option to displacy (closes #2266) 2018-04-28 23:06:50 +02:00
ines
ce63f8997b Update init-model docs 2018-04-10 21:42:54 +02:00
ines
0e847d7fe5 Fix typo 2018-04-09 14:51:14 +02:00
ines
ce6071ca89 Remove ftfy dependency and update docs 2018-03-28 12:09:42 +02:00
ines
53680642af Port over docs changes [ci skip] 2018-03-24 17:12:48 +01:00
ines
26bc75134d Fix typo 2018-02-08 11:28:44 +01:00
ines
58eb178667 Update Doc.char_span docs [ci skip] 2018-02-07 01:08:30 +01:00
Mateusz Tatusko
dda0e58c11
Update _pos-tags.jade
really small changes to English tags description, but might help some people while working on projects
1) -PRB- should be -RRB- instead 
2) space gets tagged as _SP, and not SP
2018-01-15 12:01:51 +09:00
ines
bbee48080d Clarify hyperparameters and alias usage in spacy train (resolves #1838) [ci skip] 2018-01-14 14:32:50 +01:00
Matthew Honnibal
a2a06dce24
Merge pull request #1792 from explosion/feature-improve-model-download
💫 Improve model downloading and linking
2018-01-11 20:02:08 +01:00
pbnsilva
4cfd848bc3 Fixes typo in PhraseMatcher API docs 2018-01-11 17:35:59 +01:00
Matthew Honnibal
7ca49c2061
Merge branch 'master' into feature-improve-model-download 2018-01-10 18:21:55 +01:00
ines
ef210c73dd Update cli.download and cli.validate docs 2018-01-03 21:34:03 +01:00
ines
cc9df10e69 Document util.set_lang_class (see #1737) 2018-01-03 20:13:25 +01:00
Ines Montani
874f174ab1
Merge pull request #1790 from nirdesh37/patch-1
Update goldparse.jade
2018-01-03 18:37:07 +00:00
ines
1fa6ba8130 Fix Doc.from_array example to make it work (see #1527) 2018-01-03 16:59:38 +01:00
ines
49635350f0 Add .from_disk() to pipeline component init example (resolves #1728) 2018-01-03 16:50:24 +01:00
nirdesh37
67fdceed6a
Update goldparse.jade 2018-01-03 17:25:21 +05:30
Kristofer Berggren
1cb8c997fb
Fix typo Span -> Token on Token API page
Change Span.vector_norm to Token.vector_norm.
2017-12-17 20:32:19 +08:00
ines
24e80c51b8 Document init-model command 2017-12-07 10:14:37 +01:00
ines
b078e276e6 Document offsets_from_biluo_tags 2017-12-06 13:40:51 +01:00
Mark Dodwell
9d4c185860
Fix link to CLEAR Style dependency labels PDF 2017-12-04 23:28:06 -08:00
ines
e4ee666be5 Fix biluo_tags_from_offsets example and docs 2017-11-26 16:37:32 +01:00
pavillet
ad2935f0c3
Update _spacy.jade
Doc example gives 'object is not subscriptable' error.
Correcting as an attribuet
2017-11-17 00:02:20 +01:00
ines
40c4e8fc09 Remove "optional" from dev_data arg and add more info (see #1578) 2017-11-14 20:26:05 +01:00
KMLDS
d5b20ac3b6
Update span.jade 2017-11-13 19:27:20 -05:00
ines
4c5d2c80d5 Re-add python -m to commands, too brittle :( (see #1536) 2017-11-10 02:30:55 +01:00
ines
33b84f4c39 Change clear_vectors to reset_vectors (resolves #1516) 2017-11-08 18:11:23 +01:00
ines
97a5892347 Document Vectors.resize() and update v2 incompatibilities (resolves #1514) 2017-11-08 17:11:11 +01:00
ines
1768703e1c Update website for v2.0 2017-11-07 14:48:17 +01:00
ines
a4662a31a9 Move model package templates to cli.package and update docs 2017-11-07 12:15:35 +01:00
ines
a09c096d3c Get docs ready for v2.0.0 2017-11-07 12:00:43 +01:00
ines
912c1b1821 Document "simple training style" 2017-11-07 00:23:19 +01:00
ines
8fb48b9b91 Update and document new util functions 2017-11-07 00:22:43 +01:00
ines
972298e0c9 Update Pipe component docs and training API 2017-11-06 14:42:24 +01:00
ines
86d6bd7503 Fix wording 2017-11-05 19:23:50 +01:00
ines
a6ffa942bb Update UD schemes 2017-11-05 18:46:24 +01:00