Skip to content

Commit

Permalink
Updated docs homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
markgw committed Aug 5, 2020
1 parent 1cc2563 commit 9cfb808
Showing 1 changed file with 21 additions and 24 deletions.
45 changes: 21 additions & 24 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ provides wrappers around many
existing, widely used **NLP** (Natural Language Processing) tools.

It makes it easy to write large, potentially complex pipelines
with the following key goals:

* to provide **clear documentation** of what has been done;
* to make it easy to **incorporate standard NLP tasks**,
* and to extend the code with **non-standard tasks, specific to a pipeline**;
* to support simple **distribution of code** for reproduction, for example, on other datasets.
with the key goals of making is easy to:
* provide **clear documentation** of what has been done;
* **incorporate standard NLP tasks** and data-processing tasks with minimal effort;
* **integrate non-standard code**, specific to the task at hand, into the same pipeline; and
* **distribute code** for later reproduction or application to other datasets or experiments.

The toolkit takes care of managing data between the steps of a
pipeline and checking that everything's executed in the right order.
Expand All @@ -33,24 +32,6 @@ you can write your own processing modules using either Python 2 or 3.

Pimlico is short for *PIpelined Modular LInguistic COrpus processing*.

.. note::

**New datatypes system**

Some time ago, we changed how datatypes work internally
(previously in branch ``datatypes``), which required
all datatypes and modules to be updated to the new system.
`More info... <https://github.com/markgw/pimlico/projects/1>`_

This has been done for many of the core modules some are waiting
to be updated and
don't work. They do not appear in the documentation and can
be found in ``pimlico.old_datatypes.modules``.
Other known outstanding tasks are marked with todos:
:doc:`full todo list </plans/wishlist>`.

These issues will be resolved before v1.0 is released.

Contents
========

Expand All @@ -68,5 +49,21 @@ Contents
plans/index


.. note::

**New datatypes system**

Some time ago, we changed how datatypes work internally, requiring
all datatypes and modules to be updated.
`More info... <https://github.com/markgw/pimlico/projects/1>`_

This has been done for many of the core modules, but some are waiting
to be updated and
don't work. They do not appear in the documentation and can
be found in ``pimlico.old_datatypes.modules``.

These issues will be resolved before v1.0 is released.


* :ref:`genindex`
* :ref:`search`

0 comments on commit 9cfb808

Please sign in to comment.