Pimlico Wishlist¶
Things I plan to add to Pimlico.
- Further modules:
- CherryPicker for coreference resolution
- Berkeley Parser for fast constituency parsing
- Reconcile coref. Seems to incorporate upstream NLP tasks. Would want to interface such that we can reuse output from other modules and just do coref.
- Pipeline graph visualizations: Outputting pipeline diagrams. Maybe an interactive GUI to help with viewing large pipelines
- Email output: after a run finishes, successful or failed, send an email (if configured to do so) reporting the
- status. This would mean you could be informed immediately if something goes wrong and the pipeline exits early, or if everything completes and your output is ready.
Todos¶
The following to-dos appear elsewhere in the docs. They are generally bits of the documentation I’ve not written yet, but am aware are needed.
Todo
Describe how module dependencies are defined for different types of deps
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/core/dependencies.rst, line 73.)
Todo
Include some examples from the core modules of how deps are defined and some special cases of software fetching
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/core/dependencies.rst, line 80.)
Todo
Write documentation for this
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/core/module_structure.rst, line 9.)
Todo
Document variants
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/core/variants.rst, line 5.)
Todo
Write a guide to building document map modules.
For now, the skeletons below are a useful starting point, but there should be a more fulsome explanation here of what document map modules are all about and how to use them.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/guides/map_module.rst, line 5.)
Todo
Use a dataset that everyone can get to in the example
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/guides/setup.rst, line 84.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.embeddings.dependencies.rst, line 12.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.features.term_feature_compiler.rst, line 12.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.features.term_feature_matrix_builder.rst, line 12.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.features.vocab_builder.rst, line 12.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.features.vocab_mapper.rst, line 12.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.malt.parse.rst, line 12.)
Todo
Replace check_runtime_dependencies() with get_software_dependencies()
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.malt.parse.rst, line 17.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.opennlp.coreference.rst, line 12.)
Todo
Replace check_runtime_dependencies() with get_software_dependencies()
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.opennlp.coreference.rst, line 17.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.opennlp.parse.rst, line 12.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.regex.annotated_text.rst, line 12.)
Todo
Document this module
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.sklearn.matrix_factorization.rst, line 12.)
Todo
Replace check_runtime_dependencies() with get_software_dependencies()
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/pimlico/checkouts/v0.6/docs/modules/pimlico.modules.sklearn.matrix_factorization.rst, line 17.)