Metadata-Version: 2.1
Name: udao
Version: 1.0.1
Author-email: Chenghao Lyu <chenghao@cs.umass.edu>, Julien Fontanarava <julien.fontanarava@gmail.com>
Maintainer-email: Chenghao Lyu <chenghao@cs.umass.edu>
License: MIT License
        
        Copyright (c) 2023 Chenghao Lyu
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Bug Reports, https://github.com/angryrou/udao/issues
Project-URL: Source, https://github.com/angryrou/udao/
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mypy ==1.5.1
Requires-Dist: mypy-extensions ==1.0.0
Requires-Dist: networkx ==2.8.8
Requires-Dist: networkx-stubs ==0.0.1
Requires-Dist: numpy ==1.26.1
Requires-Dist: pandas ==2.1.1
Requires-Dist: pandas-stubs ==2.1.1.230928
Requires-Dist: scikit-learn ==1.3.1
Requires-Dist: pytorch-warmup ==0.1.1
Requires-Dist: lightning ==2.1.0
Requires-Dist: torchmetrics ==1.2.0
Requires-Dist: gensim ==4.3.2
Requires-Dist: matplotlib ==3.8.1
Requires-Dist: Platypus-Opt ==1.1.0
Requires-Dist: tensorboard ==2.15.1
Requires-Dist: dgl ==1.1.3
Requires-Dist: torch ==2.0.1
Provides-Extra: dev
Requires-Dist: pre-commit ==3.4.0 ; extra == 'dev'
Requires-Dist: types-requests ==2.31.0.10 ; extra == 'dev'
Requires-Dist: requests ==2.31.0 ; extra == 'dev'
Requires-Dist: pytest ==7.4.2 ; extra == 'dev'
Requires-Dist: pytest-cov ==4.1.0 ; extra == 'dev'
Requires-Dist: pytest-mock ==3.12.0 ; extra == 'dev'
Requires-Dist: chardet ==5.2.0 ; extra == 'dev'
Requires-Dist: sphinx ==7.2.6 ; extra == 'dev'
Requires-Dist: sphinx-book-theme ==1.1.0 ; extra == 'dev'

# UDAO
This repository is the home of the UDAO library - a next-generation unified data analytics optimizer.

References:
- [Spark-based Cloud Data Analytics using Multi-Objective Optimization](https://ieeexplore.ieee.org/document/9458826/)
- [UDAO: a next-generation unified data analytics optimizer](https://dl.acm.org/doi/10.14778/3352063.3352103)

## Getting Started

### Install

Using pip:

```
pip install udao
```

### Install on GPU

The current GPU version relies on CUDA 11.8 and PyTorch 2.0.1. The following instructions are for installing the GPU version of UDAO.

#### Requirements

Before installing, please make sure you have the following dependencies installed (using pip):

```
pip install cuda-python==11.8
pip install torch==2.0.1 -f https://download.pytorch.org/whl/cu118
pip install torchvision==0.15.2 -f https://download.pytorch.org/whl/cu118
pip install torchaudio==2.0.2 -f https://download.pytorch.org/whl/cu118
pip install dglgo==0.0.2
pip install dgl -f https://data.dgl.ai/wheels/cu118/repo.html
```

### Documentation
You can find the documentation on our (GitHub Pages)[https://angryrou.github.io/udao/]

## Limitations

Some known limitations:
1. Pandas DataFrame may have limitations when working with very large datasets.
2. Optimization algorithms require independent functions for each objective or constraint, impacting optimization speed, which may not match the speed achieved in our referenced papers (a fix is planned soon)
3. Categorical variables are always enumerated in MOGD.
4. Preprocessed data is not cached for reuse in hyper-parameter tuning

## Contributing

We welcome contributions!
You can go to [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
