Home

Overview

The arctix package consists of functionalities to prepare dataset of asynchronous time series. It is design to make dataset preparation reusable and reproducible. For each dataset, arctix provides 3 main functions:

• fetch_data to load the raw data are loaded in a polars.DataFrame. When possible, it downloads automatically the data.
• prepare_data to prepare the data. It outputs the prepared data in polars.DataFrame, and the metadata.
• to_array to convert the prepared data to a dictionary of numpy arrays.

For example, it is possible to use the following lines to download and prepare the MultiTHUMOS data.

>>> from pathlib import Path
>>> from arctix.dataset.multithumos import fetch_data, prepare_data, to_array
>>> dataset_path = Path("/path/to/dataset/multithumos")
>>> data_raw = fetch_data(dataset_path)  # doctest: +SKIP
>>> data, metadata = prepare_data(data_raw)  # doctest: +SKIP
>>> arrays = to_array(data)  # doctest: +SKIP

API stability

While arctix is in development stage, no API is guaranteed to be stable from one release to the next. In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release. In practice, this means that upgrading arctix to a new version will possibly break any code that was using the old version of arctix.

License

arctix is licensed under BSD 3-Clause "New" or "Revised" license available in LICENSE file.