Metadata-Version: 2.3
Name: MolMiner-graphs
Version: 0.0.1
Summary: For Creaming Molecular Graph Models
Author: Tony Eight Lin
Author-email: Tony Eight Lin <tonyelin@tmu.edu.tw>
License: Apache-2.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: matplotlib>=3.10.3
Requires-Dist: numpy>=2.0
Requires-Dist: pandas>=2.1
Requires-Dist: rdkit>=2023.9.5
Requires-Dist: seaborn>=0.12.2
Requires-Dist: scikit-learn>=1.6.1
Requires-Dist: torch>=2.1.0
Requires-Dist: torchinfo>=1.8.0
Requires-Dist: torch-geometric>=2.6.1
Requires-Dist: torchviz>=0.0.3
Requires-Dist: tabulate>=0.9.0
Requires-Dist: optuna>=4.9.0
Requires-Dist: mlx>=0.31.1 ; extra == 'mlx'
Requires-Dist: mlx-graphs>=0.0.9 ; extra == 'mlx'
Requires-Python: >=3.11
Provides-Extra: mlx
Description-Content-Type: text/markdown

# MolMiner - Graphs
[![Molecular Miner - Graphs](https://img.shields.io/pypi/v/MolMiner-graphs.svg?label=MolMiner-Graphs&style=flat)]()
[![Python Versions](https://img.shields.io/badge/python-3.11+-blue.svg?logo=python&logoColor=white)](https://pypi.org/project/mlx-mol-cluster/)
[![pytorch](https://img.shields.io/badge/PyTorch-2.1.0+-EE4C2C.svg?style=flat&logo=pytorch)](https://pytorch.org)
[![MLX](https://img.shields.io/badge/MLX-0.31.0+-black?logo=apple&labelColor=gray)](https://github.com/ml-explore/mlx)

## Overview
This repo is a companion to the MolMiner project. It is focused on building deep learning molecular graph models built
using PyTorch or MLX.

## Install

Installation of MolMiner-graphs is done as follows:

```bash
pip install MolMiner-graphs
```

By default, this will only install the PyTorch backend. For users interested in MLX, this requires workstations using 
Apple Silicon and can be installed as follows:
```bash
pip install "MolMiner-graphs[mlx]"
```
This will install both PyTorch and MLX on the Apple Silicon workstation.

## Tutorials

Tutorials and examples of how to use MolMiner-Graphs can be seen at the [Tutorials](tutorials/) directory. 