diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index d9cab7c..8887f5b 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,6 +1,6 @@ name: Run tests -on: [push, workflow_dispatch] +on: [push] jobs: test: diff --git a/README.md b/README.md index adec366..3771db1 100644 --- a/README.md +++ b/README.md @@ -100,3 +100,11 @@ bike car subway taxi-bus train walk precision 89.83 79.1 82.35 91.42 87.88 95.76 ``` +## Available datasets + +See the whole [list of datasets](https://github.com/yupidevs/trajectory-datasets) compatible with pactus + + +## Contributing + +Follow the guidlines from [pactus documentation](https://pactus.readthedocs.io/en/latest/) \ No newline at end of file diff --git a/docs/source/available_datasets/available_datasets.rst b/docs/source/available_datasets/available_datasets.rst new file mode 100644 index 0000000..c822846 --- /dev/null +++ b/docs/source/available_datasets/available_datasets.rst @@ -0,0 +1,75 @@ +Available datasets +================== + +All datasets are available in the `releases section +`_ of the `trajectory +dataset `_ repository. + +.. list-table:: + :header-rows: 1 + + * - Dataset + - Description + - Classification Goal + * - geolife + - | Records of people + | outdoor movements + - | **Transportation mode:** + | walk • bike • bus • car • subway + | train • airplane • boat • run + | motorcycle + * - animals + - | Elk, deer and cattle dataset. + | `Starkey Project `_ + - | **Animal species** + | Elk • Deer • Cattle + * - hurdat2 + - | Atlantic hurricane database + - | **Huracane intensity (Saffir-Simpson scale):** + | 0 • 1 • 2 • 3 • 4 • 5 + | *(Zero means it was not a hurricane)* + * - mnist_stroke + - | Sequences of strokes + | representing + | handwritten digits + - | **Decimal digits:** + | 1 • 2 • 3 • 4 • 5 • 6 • 7 • 8 • 9 • 0 + * - cma_bst + - | Western North Pacific tropical + | cyclone database + - | **Huracane intensity:** + | Weaker or unknown • Tropical Depression + | Tropical Storm • Severe Tropical Storm + | Typhoon • Severe Typhoon • Super Typhoon + | Extratropical Cyclone + * - uci_gotrack + - Cars and buses GPS trayectories + - | **Transportation mode:** + | bus • car + * - uci_pen_digits + - | Pen-Based Recognition of + | Handwritten Digits + - | **Decimal digits:** + | 1 • 2 • 3 • 4 • 5 • 6 • 7 • 8 • 9 • 0 + * - uci_characters + - Character Trajectories Data Set + - | **Characters:** + | a • b • c • d • e • g • h • l • m • n • o + | p • q • r • s • u • v • w • y • z + * - uci_movement_libras + - | LIBRAS (brazilian signal + | language) movement dataset + - | **Movement type:** + | curved swing • horizontal swing + | vertical swing • anti-clockwise arc + | clockwise arc • horizontal straight-line + | circle • vertical straight-line + | horizontal zigzag • vertical zigzag + | horizontal wavy • vertical wavy + | face-up curve • face-down curve • tremble + * - stochastic_models + - | Trajectories generated + | using statistical models + - | **Model used:** + | Random Walk • Langevin Ecquation + | Diffusing Diffusivity \ No newline at end of file diff --git a/docs/source/contributing/adding_datasets.rst b/docs/source/contributing/adding_datasets.rst new file mode 100644 index 0000000..58c23aa --- /dev/null +++ b/docs/source/contributing/adding_datasets.rst @@ -0,0 +1,2 @@ +Adding datasets +=============== \ No newline at end of file diff --git a/docs/source/contributing/adding_featurizers.rst b/docs/source/contributing/adding_featurizers.rst new file mode 100644 index 0000000..017b6a5 --- /dev/null +++ b/docs/source/contributing/adding_featurizers.rst @@ -0,0 +1,2 @@ +Adding featurizers +================== diff --git a/docs/source/contributing/adding_models.rst b/docs/source/contributing/adding_models.rst new file mode 100644 index 0000000..d3be7c7 --- /dev/null +++ b/docs/source/contributing/adding_models.rst @@ -0,0 +1,2 @@ +Adding models +============= diff --git a/docs/source/contributing/engaging.rst b/docs/source/contributing/engaging.rst new file mode 100644 index 0000000..c70c628 --- /dev/null +++ b/docs/source/contributing/engaging.rst @@ -0,0 +1,2 @@ +Increasing Visibility and Engagement +==================================== \ No newline at end of file diff --git a/docs/source/contributing/report_issues.rst b/docs/source/contributing/report_issues.rst new file mode 100644 index 0000000..275423f --- /dev/null +++ b/docs/source/contributing/report_issues.rst @@ -0,0 +1,2 @@ +Report issues +============= diff --git a/docs/source/examples/example1.rst b/docs/source/examples/example1.rst new file mode 100644 index 0000000..1b1d025 --- /dev/null +++ b/docs/source/examples/example1.rst @@ -0,0 +1,2 @@ +Example 1 +========= \ No newline at end of file diff --git a/docs/source/examples/example2.rst b/docs/source/examples/example2.rst new file mode 100644 index 0000000..c346340 --- /dev/null +++ b/docs/source/examples/example2.rst @@ -0,0 +1,2 @@ +Example 2 +========= diff --git a/docs/source/examples/example3.rst b/docs/source/examples/example3.rst new file mode 100644 index 0000000..249a5da --- /dev/null +++ b/docs/source/examples/example3.rst @@ -0,0 +1,2 @@ +Example 3 +========= diff --git a/docs/source/examples/example4.rst b/docs/source/examples/example4.rst new file mode 100644 index 0000000..92e2130 --- /dev/null +++ b/docs/source/examples/example4.rst @@ -0,0 +1,2 @@ +Example 4 +========= diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst new file mode 100644 index 0000000..6cbecfd --- /dev/null +++ b/docs/source/getting_started/installation.rst @@ -0,0 +1,13 @@ +Installation and compatibility +============================== + +To start using pactus, simply install it from pypi: + +>>> pip install pactus + +pactus is compatible with: + + * Python 3.8 or later + * Ubuntu 18.04 or later + * Windows 7 or later + * macOS 10.12.6 (Sierra) or later. diff --git a/docs/source/getting_started/support.rst b/docs/source/getting_started/support.rst new file mode 100644 index 0000000..09b39d5 --- /dev/null +++ b/docs/source/getting_started/support.rst @@ -0,0 +1,15 @@ +Getting Support +=============== + +There are different options you can use for support: + + * You can ask questions and join the development discussion on our `Telegram group `_. + + * You can also post bug reports and feature requests in `GitHub issues `_. + + * You can email us directly: + + * | Gustavo Viera López + * | Alfredo Reyes + * | Jorge Morgado + \ No newline at end of file diff --git a/docs/source/images/example.jpg b/docs/source/images/example.jpg new file mode 100644 index 0000000..9d8cf83 Binary files /dev/null and b/docs/source/images/example.jpg differ diff --git a/docs/source/index.rst b/docs/source/index.rst index a258cff..7420bb5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,15 +6,65 @@ Welcome to pactus's documentation! ================================== -.. .. toctree:: -.. :maxdepth: 2 -.. :caption: Getting Started +Standing from Path Classification Tools for Unifying Strategies, `pactus` +is a Python library that allows testing different classification methods on +several trajectory datasets. + +It comes with some built-in models and datasets according to the +state-of-the-art in trajectory classification. However, it is implemented in an +extensible way, so the users can build their own models and datasets. + +.. figure:: /images/example.jpg + :alt: Minimal example of a pactus classification task + :align: center + :width: 550 + + *pactus capabilities represented in an example classification task.* + +.. note:: + Code from the example shown above: + + .. code-block:: python + + from pactus import Dataset, featurizers + from pactus.models import RandomForestModel + + dataset = Dataset.animals() + train, test = dataset.split(0.9) + + ft = featurizers.UniversalFeaturizer() + model = RandomForestModel(featurizer=ft) + model.train(train, cross_validation=5) + + evaluation = model.evaluate(test) + evaluation.show() + + +.. toctree:: + :maxdepth: 2 + :caption: Getting Started + + getting_started/installation + getting_started/support + +.. toctree:: + :maxdepth: 2 + :caption: Examples + + examples/example1 + examples/example2 + examples/example3 + examples/example4 + +.. toctree:: + :maxdepth: 2 + :caption: Contributing -.. GS/Installation -.. Getting Support -.. GS/Contributing -.. GS/About -.. GS/FAQ + contributing/engaging + contributing/report_issues + contributing/adding_datasets + contributing/adding_models + contributing/adding_featurizers .. .. toctree:: .. :maxdepth: 2 @@ -32,6 +82,7 @@ Welcome to pactus's documentation! :maxdepth: 2 :caption: Advanced Resources + available_datasets/available_datasets api_reference/api_reference diff --git a/examples/mnist_stroke_example.py b/examples/example_03.py similarity index 100% rename from examples/mnist_stroke_example.py rename to examples/example_03.py diff --git a/examples/trasnformer_example.py b/examples/example_04.py similarity index 98% rename from examples/trasnformer_example.py rename to examples/example_04.py index 8d34a9b..7cd3af3 100644 --- a/examples/trasnformer_example.py +++ b/examples/example_04.py @@ -14,6 +14,7 @@ Dataset.hurdat2(), Dataset.cma_bst(), Dataset.mnist_stroke(), + Dataset.uci_pen_digits(), Dataset.uci_gotrack(), Dataset.uci_characters(), Dataset.uci_movement_libras(), diff --git a/paper/1.pdf b/paper/1.pdf index 9abeddb..5f5e09a 100644 Binary files a/paper/1.pdf and b/paper/1.pdf differ