> For the complete documentation index, see [llms.txt](https://developer-mina.gitbook.io/setify/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer-mina.gitbook.io/setify/master.md).

# setify

### Getting Started 

The core data structure of Setify is **datasets,** and it is the simplest way to download a dataset, Here is an example of downloading the logical gate `XOR` dataset: 

```python
from setify import datasets

df = datasets.logic_gate_xor()
print(df)
```

**datasets** return Pandas DataFrame,  The previous code will output the following DataFrame: 

```python
   x1  x2  y
0   0   0  0
1   0   1  1
2   1   0  1
3   1   1  0
```

Setify let you use datasets with low latency and high availability by downloading the requested datasets on your local machine, If you are downloading the dataset for the first time Setify will create a new `.h5`  file with the same dataset name in your home directory under `.setify/datasets` , Setify is using the **HDF5** file data structure model for better handling of extremely large and complex data.

The previous code will store the `XOR` dataset in the following location:

```bash
~/.setify/datasets/logic_gate_xor.h5
```

Setify is also available in **JSON** format, for example, the `XOR` dataset can be requested from the following link: 

```bash
https://setify-server.herokuapp.com/logic_gate_xor
```

### Installation 

#### Installing Setify from PyPI (recommended) 

The following installation command is assuming that you are on a Linux or MAC operating systems:

```bash
sudo pip install setify
```

If you are using windows or a virtual environment:

```bash
pip install setify 
```

#### Alternatively, you can install Setify from GitHub: 

```bash
git clone https://github.com/MinaGabriel/setify.git
cd setify
sudo python setup.py install 
```

### Additional Information

* **Version**: 0.9
* **Updated:** May 12, 2021
* **Language:** English 
* **Developer:** <developer.mina@gmail.com>

### Current Release

To check the currently installed version you can run:

```python
import setify 
print(setify.__version__) 
```

{% hint style="success" %}
[Source code(zip)](https://github.com/MinaGabriel/setify/archive/refs/tags/v0.9.tar.gz)
{% endhint %}

### License&#x20;

This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).<br>

![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)