coola 0.0.1

coola is a library to check if two complex/nested objects are equal or not

coola

Overview

coola is a Python library that provides simple functions to check in a single line if two complex/nested objects are equal or not. coola was initially designed to work with PyTorch Tensors and NumPy ndarray, but it is possible to extend it to support other data structures.

Motivation

Let's imagine you have the following dictionaries that contain both a PyTorch Tensor and a NumPy ndarray. You want to check if the two dictionaries are equal or not. By default, Python does not provide an easy way to check if the two dictionaries are equal or not. It is not possible to use the default equality operator == because it will raise an error. The coola library was developed to fill this gap. coola provides a function objects_are_equal that can indicate if two complex/nested objects are equal or not.

import numpy
import torch

from coola import objects_are_equal

data1 = {'torch': torch.ones(2, 3), 'numpy': numpy.zeros((2, 3))}
data2 = {'torch': torch.zeros(2, 3), 'numpy': numpy.ones((2, 3))}

objects_are_equal(data1, data2)

coola also provides a function objects_are_allclose that can indicate if two complex/nested objects are equal within a tolerance or not.

from coola import objects_are_allclose

objects_are_allclose(data1, data2, atol=1e-6)

Please check the [quickstart page](TODO: add link) to learn more on how to use coola.

Installation

We highly recommend installing a virtual environment. coola can be installed from pip using the following command:

pip install coola

To make the package as slim as possible, only the minimal packages required to use coola are included. To include all the packages, you can use the following command:

pip install coola[all]

Please check the [get started page](TODO: add link) to see how to install only some specific packages or other alternatives to install the library.

Contributing

Please let us know if you encounter a bug by filing an issue.

We welcome contributions from anyone, even if you are new to open source.

• If you are planning to contribute back bug-fixes, please do so without any further discussion.
• If you plan to contribute new features, utility functions, or extensions to the core, please first open an issue and discuss the feature with us.

Once you implement and test your feature or bug-fix, please submit a Pull Request.

Please feel free to open an issue to share your feedback or to request new features.

API stability

:warning: While coola 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 coola to a new version will possibly break any code that was using the old version of coola.

License

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