Skip to main content

Kaiwu Community

Python Version License

Language: 中文 | English


Kaiwu Community is a Python development toolkit designed specifically for QUBO (Quadratic Unconstrained Binary Optimization) problems, providing rapid modeling, flexible extension, and efficient solving capabilities.

Installation

pip install kaiwu_community

Requirements:

  • Python 3.10.x
  • Make (for development builds)
  • Virtualenv (optional, for environment isolation)

For more installation information, please refer to the Installation Documentation.


Quick Start

Learning Resources

Getting Help

Example: Traveling Salesman Problem (TSP)

This example demonstrates how to solve the Traveling Salesman Problem using Kaiwu SDK Community, including the following steps:

  • Build a TSP problem model using a distance matrix
  • Define QUBO objective function and constraints
  • Solve the model using built-in solvers
  • Validate the solution results

For the complete TSP example code, please see example/tsp_sdk_1_2_doc_example.py.

For more detailed explanations, please refer to the TSP Documentation.


Application Scenarios

Kaiwu SDK is suitable for:

  • Combinatorial Optimization: Traveling Salesman Problem (TSP), Knapsack Problem, Graph Coloring, Max-Cut
  • Machine Learning: Feature Selection, Cluster Analysis, Model Compression
  • Quantum Computing Research: QUBO Model Research, Solver Development, Quantum Algorithm Verification

Contributing

Community contributions are welcome! 🎉

You can extend SDK functionality, such as new solver implementations, classical optimization algorithms, example programs, and documentation.

Contribution Example

Quickly extend functionality by inheriting base classes:

from kaiwu.core import IsingSolver, QuboSolver
import kaiwu

# Custom optimizer
class CustomOptimizer(IsingSolver):
    def solve(self, ising_matrix=None):
        # Implement custom optimization logic
        pass

# Custom solver
class CustomSolver(QuboSolver):
    def solve_qubo(self, model):
        # Implement custom solver logic
        pass

# Modeling
qubo_model = kaiwu.qubo.QuboModel()
# Calling the custom component
optimizer = CustomOptimizer()
solver = CustomSolver(optimizer)
result = solver.solve_qubo(qubo_model)

➡️ For detailed contribution guidelines, please refer to the Contributing Guide.


License

This project is open-sourced under the Apache License 2.0. For details, please see the LICENSE file.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kaiwu_community-1.0.7.tar.gz (34.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kaiwu_community-1.0.7-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

Details for the file kaiwu_community-1.0.7.tar.gz.

File metadata

  • Download URL: kaiwu_community-1.0.7.tar.gz
  • Upload date:
  • Size: 34.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for kaiwu_community-1.0.7.tar.gz
Algorithm Hash digest
SHA256 8fe4b732cc1e69d7a7ac35f7969a80efe582fbc82e8c0613a2825b464710985d
MD5 08d05460f1ff2daab03712b478c7cb49
BLAKE2b-256 246fcdb10b501a72c483fe6f44d08af9f36baaf00a5f9be76b7bf340236f2bb3

See more details on using hashes here.

Provenance

The following attestation bundles were made for kaiwu_community-1.0.7.tar.gz:

Publisher: release.yml on qboson/kaiwu_community

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kaiwu_community-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: kaiwu_community-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 42.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for kaiwu_community-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 283c5e1a165ffc2d29b32428cef87762e82cfcb30655960b4dbd063740ba0330
MD5 48980bc94dc2fe3f1c59a287182ea0b7
BLAKE2b-256 08f3af0733cd1909941c10016f1d02161ab8ea122fa5b44e2801d53f69eaa5b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for kaiwu_community-1.0.7-py3-none-any.whl:

Publisher: release.yml on qboson/kaiwu_community

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.0.7 This release

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page