spaCy/extra/DEVELOPER_DOCS
Paul O'Leary McCann 9ceb8f413c
StringStore/Vocab dev docs (#9142)
* First take at StringStore/Vocab docs

Things to check:

1. The mysterious vocab members
2. How to make table of contents? Is it autogenerated?
3. Anything I missed / needs more detail?

* Update docs

* Apply suggestions from code review

Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>

* Updates based on review feedback

* Minor fix

* Move example code down

Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>
2021-09-16 12:50:22 +09:00
..
Code Conventions.md Add development docs for Language and code conventions (#8745) 2021-08-17 09:38:15 +02:00
Language.md Add development docs for Language and code conventions (#8745) 2021-08-17 09:38:15 +02:00
Listeners.md Dev docs: listeners (#9061) 2021-08-30 14:56:35 +02:00
README.md Add development docs for Language and code conventions (#8745) 2021-08-17 09:38:15 +02:00
StringStore-Vocab.md StringStore/Vocab dev docs (#9142) 2021-09-16 12:50:22 +09:00

README.md

Developer Documentation

This directory includes additional documentation and explanations of spaCy's internals. It's mostly intended for the spaCy core development team and contributors interested in the more complex parts of the library. The documents generally focus on more abstract implementation details and how specific methods and algorithms work, and they assume knowledge of what's already available in the usage documentation and API reference.

If you're looking to contribute to spaCy, make sure to check out the documentation and contributing guide first.