adds two tutorials to package documentation that help beginners learn how to do tangible things using textacy
updates existing home and installation docs to accurately reflect current spacy and textacy functionality
makes a few minor code changes, noticed during docs-writing
adds Corpus.agg_metadata() method, to aggregate metadata over all docs in a corpus for easy inspection
adds types.Record named tuple, which provides access to text and meta data by both name and index
bumps min matplotlib version, 1.5 => 3.0
Motivation and Context
textacy's "quickstart" is... a lot, and blends different types of documentation together. New users of the package would benefit from a set of proper tutorials to get them going.
How Has This Been Tested?
a test suite for one of the two tutorials was added, and all tests pass; leaving the second one untested (for now) because i'm burnt out on code development and will probably do a big overhaul of topic modeling functionality at some point in the future. so, i'm punting.
Screenshots (if appropriate):
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
[x] My code follows the code style of this project.
[x] My change requires a change to the documentation, and I have updated it accordingly.
Description
textacyCorpus.agg_metadata()method, to aggregate metadata over all docs in a corpus for easy inspectiontypes.Recordnamed tuple, which provides access to text and meta data by both name and indexmatplotlibversion, 1.5 => 3.0Motivation and Context
textacy's "quickstart" is... a lot, and blends different types of documentation together. New users of the package would benefit from a set of proper tutorials to get them going.
How Has This Been Tested?
a test suite for one of the two tutorials was added, and all tests pass; leaving the second one untested (for now) because i'm burnt out on code development and will probably do a big overhaul of topic modeling functionality at some point in the future. so, i'm punting.
Screenshots (if appropriate):
Types of changes
Checklist: