Metadata-Version: 2.4
Name: dwave-preprocessing
Version: 0.6.11
Summary: An API for preprocessing tools
Home-page: https://github.com/dwavesystems/dwave-preprocessing
Download-URL: https://github.com/dwavesystems/dwave-preprocessing/releases
Author: D-Wave Systems Inc.
Author-email: tools@dwavesys.com
License: Apache 2.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
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-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy<3.0.0,>=1.21.6
Requires-Dist: dimod<0.13.0,>=0.12.21
Dynamic: download-url
Dynamic: license-file
Dynamic: requires-dist

.. image:: https://circleci.com/gh/dwavesystems/dwave-preprocessing.svg?style=svg
    :target: https://circleci.com/gh/dwavesystems/dwave-preprocessing
    :alt: Linux/Mac/Windows build status

.. image:: https://codecov.io/gh/dwavesystems/dwave-preprocessing/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/dwavesystems/dwave-preprocessing
    :alt: Code coverage

.. image:: https://badge.fury.io/py/dwave-preprocessing.svg
    :target: https://badge.fury.io/py/dwave-preprocessing
    :alt: Last version on PyPI

.. image:: https://img.shields.io/pypi/pyversions/dwave-preprocessing.svg?style=flat
    :target: https://pypi.org/project/dwave-preprocessing/
    :alt: PyPI - Python Version


===================
dwave-preprocessing
===================

.. start_preprocessing_about

`dwave-preprocessing` provides preprocessing tools for binary quadratic models
(BQM) and presolve algorithms for constrained quadratic models (CQM).

This package contains several preprocessing composites that can aid in solving
BQMs and a presolver that can reduce a problem's redundant variables and
constraints to improve the accuracy of CQMs. For details on underlying
algorithms and usage, see the
`documentation <https://docs.dwavequantum.com/en/latest/index.html>`_.

.. end_preprocessing_about

Installation
============

Install from a package on PyPI:

.. code-block:: bash

    pip install dwave-preprocessing

or install from source:

.. code-block:: bash

    pip install -r requirements.txt
    python setup.py build_ext --inplace
    python setup.py install

License
=======

Released under the Apache License 2.0. See `<LICENSE>`_ file.

Contributing
============

Ocean's `contributing guide <https://docs.dwavequantum.com/en/latest/ocean/contribute.html>`_
has guidelines for contributing to Ocean packages.

Release Notes
-------------

**dwave-preprocessing** makes use of `reno <https://docs.openstack.org/reno/>`_
to manage its release notes.

When making a contribution to **dwave-preprocessing** that will affect users,
create a new release note file by running

.. code-block:: bash

    reno new your-short-descriptor-here

You can then edit the file created under ``releasenotes/notes/``.
Remove any sections not relevant to your changes.
Commit the file along with your changes.
