Metadata-Version: 2.1
Name: pyispace
Version: 0.3.2
Summary: Python Instance Space Analysis package
Home-page: https://gitlab.com/ita-ml/pyispace
Author: Pedro Paiva
Author-email: paiva@ita.br
License: MIT
Download-URL: https://gitlab.com/ita-ml/pyispace/-/archive/v0.3.2/pyispace-v0.3.2.tar.gz
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# PyISpace

_Python Instance Space Analysis Toolkit_

<!--![picture](docs/img/circle-fs.png)-->

## Getting Started

This is the Python version of the [Instance Space Analysis](https://github.com/andremun/InstanceSpace) (ISA) toolkit, originally written in Matlab code. The original ISA toolkit was developed as part of the project [MATILDA](https://matilda.unimelb.edu.au/matilda/about-matilda), at the University of Melbourne, Australia.

PyISpace is a Python package that contains a subset of the tools present in the original Matlab code repository. It is not our intention to add new features to the toolkit. For a complete experience of all tools, we recommend the original code, or the [web version](https://matilda.unimelb.edu.au/matilda/).

### Requirements
Python 3.7 or newer.

### Installation

Via PyPi:

```
pip install pyispace
```

Or directly from the repository code:
```
git clone https://gitlab.com/ita-ml/pyispace.git
cd pyispace/
pip install -e .
```


### Usage

1. Command Line Interface

Inside the folder (`rootdir`) containing the required files ``options.json`` and ``metadata.csv``, run  
```
isa
```

Optionally, the `rootdir` path may be passed with `-r` or `--rootdir`:
```
isa -r /Users/user/workspace/
```

For more information about these files, please refer to the original repository instructions.

2. Python package

```
from pyispace import train_is
model = train_is(metadata, opts)
```

#### Disabling messages
PyISpace uses [logging](https://docs.python.org/3/library/logging.html) to display messages. You can disable the messages, for example, changing the level associated to the package: 

```
logging.getLogger("pyispace").setLevel(logging.ERROR)
```

