Metadata-Version: 2.1
Name: jijbench
Version: 0.5.7
Summary: Experiment management and benchmark tools for mathematical optimization
Home-page: https://www.j-ij.com/
License: MIT
Author: Jij Inc.
Author-email: info@j-ij.com
Requires-Python: >=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.11.*
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: dill (>=0.3.6,<0.4.0)
Requires-Dist: jijmodeling (>=0.13.1,<0.14.0)
Requires-Dist: jijzept (>=1.15.2,<2.0.0)
Requires-Dist: kaleido (==0.2.1)
Requires-Dist: matplotlib (>=3.7.1,<4.0.0)
Requires-Dist: nbformat (>=5.8.0,<6.0.0)
Requires-Dist: networkx (>=2.0,<3.0)
Requires-Dist: numpy (>=1.24.2,<2.0.0)
Requires-Dist: pandas (>=1.5.3,<2.0.0)
Requires-Dist: plotly (>=5.14.0,<6.0.0)
Requires-Dist: streamlit (>=1.20.0,<2.0.0)
Requires-Dist: streamlit-ace (>=0.1.1,<0.2.0)
Requires-Dist: streamlit-aggrid (>=0.3.4,<0.4.0)
Requires-Dist: streamlit-elements (>=0.1.0,<0.2.0)
Requires-Dist: streamlit-tree-select (>=0.0.5,<0.0.6)
Project-URL: Documentation, https://jij-inc.github.io/JijBench
Project-URL: Repository, https://github.com/Jij-Inc/JijBench
Description-Content-Type: text/markdown


# JijBench: An Experiment and Benchmark Management Library for Mathematical Optimization

[![PyPI version shields.io](https://img.shields.io/pypi/v/jijbench.svg)](https://pypi.python.org/pypi/jijbench/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/jijbench.svg)](https://pypi.python.org/pypi/jijbench/)
[![PyPI implementation](https://img.shields.io/pypi/implementation/jijbench.svg)](https://pypi.python.org/pypi/jijbench/)
[![PyPI format](https://img.shields.io/pypi/format/jijbench.svg)](https://pypi.python.org/pypi/jijbench/)
[![PyPI license](https://img.shields.io/pypi/l/jijbench.svg)](https://pypi.python.org/pypi/jijbench/)
[![PyPI download month](https://img.shields.io/pypi/dm/jijbench.svg)](https://pypi.python.org/pypi/jijbench/)
[![Downloads](https://pepy.tech/badge/jijbench)](https://pepy.tech/project/jijbench)

[![Python Test](https://github.com/Jij-Inc/JijBench/actions/workflows/python-test.yml/badge.svg)](https://github.com/Jij-Inc/JijBench/actions/workflows/python-test.yml)
[![CodeQL](https://github.com/Jij-Inc/JijBench/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Jij-Inc/JijBench/actions/workflows/github-code-scanning/codeql)
[![Upload Python Package](https://github.com/Jij-Inc/JijBench/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Jij-Inc/JijBench/actions/workflows/python-publish.yml)
[![codecov](https://codecov.io/gh/Jij-Inc/JijBench/branch/main/graph/badge.svg?token=pfEmtaSP8Z)](https://codecov.io/gh/Jij-Inc/JijBench)


JijBench is a Python library designed for developers working on research and development or proof-of-concept experiments using mathematical optimization. Positioned similarly to mlflow in the machine learning field, JijBench provides features such as saving optimization results, automatically computing benchmark metrics, and offering visualization tools for the results.

Primarily supporting Ising optimization problems, JijBench plans to extend its support to a wide range of optimization problems, such as MIP solvers, in the future.

## Installation
JijBench can be easily installed using pip.

``` shell
pip install jijbench
```

## Documentation and Support

Documentation: https://jij-inc.github.io/JijBench/

Tutorials will be provided in the future. Stay tuned!


## How to Contribute

See [CONTRIBUITING.md](CONTRIBUTING.md) 

---

Copyright (c) 2023 Jij Inc.


