Commit Graph

143 Commits

Author SHA1 Message Date
ines
53a2bc8c8d Only scroll sidebar item into view if needed [ci skip] 2018-06-12 10:58:50 +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
ines
c9547b7b8b Update Juniper (see #2293) 2018-05-03 15:36:02 +02:00
ines
6efb4cdf88 Use Juniper and tidy up 2018-04-30 18:48:35 +02:00
ines
45bb8d75a5 Fix overflow issues on small screens [ci skip] 2018-04-29 03:17:36 +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
4a3bea00c7 Update resources [ci skip] 2018-04-26 22:10:34 +02:00
ines
53680642af Port over docs changes [ci skip] 2018-03-24 17:12:48 +01:00
ines
954f8cc6d1 Update syntax theme (should move the modifications out to an extension sometime) 2017-11-17 19:13:53 +01:00
ines
b3e502a076 Add videos section to resources 2017-11-13 08:29:57 +01:00
ines
4c5d2c80d5 Re-add python -m to commands, too brittle :( (see #1536) 2017-11-10 02:30:55 +01:00
ines
94cd3d51db Update v2 docs and model info
Take out speed tables until we fix our benchmark tests on CPU and GPU
2017-11-08 11:43:00 +01:00
ines
3b0699c9fe Update benchmarks and data table style 2017-11-06 19:36:02 +01:00
ines
333bef482f Update pattern for Prism.js Python 2017-11-06 02:44:24 +01:00
ines
a9c77e01b4 Add accordion component (collapsible section) 2017-11-05 16:08:13 +01:00
ines
b53c2010db Add global focus style for links 2017-11-05 16:07:00 +01:00
ines
f092506578 Use hidden attribute instead of style.display 2017-11-05 16:06:50 +01:00
ines
2940938bd8 Use more distinct style for checkboxes in quickstart 2017-11-04 14:24:30 +01:00
ines
d0f88af5b6 Hide error earlier 2017-11-03 11:29:04 +01:00
ines
43512c68b2 Fix vector details in model overview 2017-11-02 20:04:13 +01:00
ines
15cbc61a6e Adjust rendering of large numbers
1234 -> 1.2k
12345 -> 12.3k
123456 -> 123k
1234567 -> 1.2m
2017-11-02 16:13:18 +01:00
ines
408f450ce0 Tidy up 2017-11-01 23:01:12 +01:00
ines
e5a4c31bb4 Adjust code line height 2017-11-01 19:49:42 +01:00
ines
9b4c38fe9f Add button option to terminal component 2017-11-01 19:49:27 +01:00
ines
12954ab218 Don't document the tensorizer for now 2017-11-01 19:49:04 +01:00
ines
4f77bb8476 Fix error handling 2017-11-01 16:29:55 +01:00
ines
a6f6bd6c98 Adjust tag spacing 2017-11-01 02:04:00 +01:00
ines
092333afd4 Update vector details and number conversion 2017-11-01 01:47:31 +01:00
ines
5fd851a80b Log errors 2017-11-01 01:46:50 +01:00
ines
3ffbb64ab6 Unify chart options and update styleguide 2017-10-30 17:25:49 +01:00
ines
14ad92d337 Ensure fallbacks / progressive enhancement if JS disabled 2017-10-30 16:16:19 +01:00
ines
1eb1ed0c7c Add tool for model comparison (experimental)
User can select two model and their meta is fetched from GitHub. Features, accuracy figures and speed benchmarks are displayed in a table, with an additional chart comparing the accuracy scores if available. Main use case: demonstrating and visualising trade-offs between larger and smaller models of the same type.
2017-10-30 14:09:43 +01:00
ines
38ef4274b6 Remove confusing icon for non-compatible models
ModelLoader will now output "not compatible" if no compatible version of model is found for a spaCy version
2017-10-30 14:07:42 +01:00
ines
8db3da3c3d Refactor JS, split into modules and add nomodule option
rollup.js will be compiled by the rollup package and Babel on build, and will be loaded if a browser doesn't yet support JS modules
2017-10-30 14:06:25 +01:00
ines
df149455f9 Don't ever wrap navigation bar contents 2017-10-30 13:16:20 +01:00
ines
74dd0ee2c2 Prevent responsive tables form scrolling vertically 2017-10-30 13:16:06 +01:00
ines
25f6331550 Allow other style arguments on +grid-col 2017-10-30 13:15:30 +01:00
ines
ae2ad5becc Remove charts from model direcory and add speed benchmarks
With speed benchmarks, charts ended up taking up too much space – and they were mostly data porn and not particularly useful anyways. Instead, we might add a "Compare" page that fetches all models and lets the user compare two or more models in terms of accuracy, speed etc.
2017-10-29 03:58:19 +01:00
ines
47fd254ba7 Combine table scroll shadows if row has only one cell 2017-10-29 03:56:37 +01:00
ines
b11928abc2 Adjust labels, spacing and hack specificity 2017-10-29 03:56:09 +01:00
ines
53bfcdba31 Make tooltips/tags and old/new code blocks more accessible (see #(see #1471))
Always add tooltip text as hidden label. Use different tooltip icons for tags and inline help icons. Add labels to old/new code blocks and add option to customise label text.
2017-10-29 01:17:49 +02:00
ines
70de2dd035 Display vectors in models directory if available (see #1457) 2017-10-25 16:15:37 +02:00
ines
db15902e84 Tidy up 2017-10-23 10:38:21 +02:00
ines
bb6ecb82e5 Ensure long file paths in code examples break if needed 2017-10-14 12:51:52 +02:00
ines
4d248ea920 Fix spacing on bulleted lists 2017-10-09 14:36:30 +02:00
ines
2ac8b5c622 Add wrapper for before/after code examples 2017-10-09 14:36:20 +02:00
ines
5fb057b575 Fix secondary font stack 2017-10-03 15:45:07 +02:00
ines
49b58d35fd Update JavaScript 2017-10-03 14:18:49 +02:00
ines
a8ff8423bb Update image assets, icons and SVGs
Move SVG sprite to Jade file and include in template. Only use SVG
symbols for logos.
2017-10-03 14:17:41 +02:00
ines
7d01d7411b Update web fonts 2017-10-03 14:15:36 +02:00