hub / github.com/Jij-Inc/ommx
github.com/Jij-Inc/ommx @python-3.0.0a8
Chat with this repo
5,236 symbols
22,293 edges
340 files
1,357 documented · 26%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
OMMX
Open Mathematical prograMming eXchange (OMMX) is an open ecosystem that empowers mathematical programming and optimization developers and reserchers.
Tutorial
English
| Title | Docs |
|---|---|
| Solving Optimization Problems with OMMX Adapter | |
| Sampling from QUBO with OMMX Adapter | |
| Comparing Results from Multiple Adapters | |
| Recording and Sharing Experiments | |
| Sharing Various Types of Data in an OMMX Artifact | |
| Downloading a MIPLIB Instance | |
| Implementing an OMMX Adapter | |
日本語
| タイトル | Docs |
|---|---|
| OMMX Adapterで最適化問題を解く | |
| OMMX AdapterでQUBOからサンプリングする | |
| 複数のAdapterで最適化問題を解いて結果を比較する | |
| 実験を記録し共有する | |
| 様々なデータをOMMX Artifact形式で共有する | |
| MIPLIBインスタンスをダウンロードする | |
| OMMX Adapterを実装する | |
SDK
See DEVELOPMENT.md about developing this project.
| SDK | Package | API Reference |
|---|---|---|
| Rust |  |
 |
| Python |  |
 |
See Supported Adapters about a complete list of supported adapters for each solver/sampler.
CLI
Prebuilt ommx CLI archives are attached to Rust SDK releases and can be installed with cargo-binstall:
cargo binstall ommx
License
© 2024 Jij Inc.
This project is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.
Contribution
TBW
Acknowledgement
This work was performed for Council for Science, Technology and Innovation (CSTI), Cross-ministerial Strategic Innovation Promotion Program (SIP), "Promoting the application of advanced quantum technology platforms to social issues"(Funding agency : QST).
Extension points exported contracts — how you extend this code
ToPandasEntry (Interface)Trait for converting a domain object into a Python dict suitable for `pd.DataFrame([...])`. [25 implementers]
python/ommx/src/pandas.rs
Parse (Interface)
Parse [`crate::v1`] messages into validated Rust types. [63 implementers]
rust/ommx/src/parse.rs
Substitute (Interface)
A trait for substituting decision variables with other functions in mathematical expressions. This trait enables the re [10 …
rust/ommx/src/substitute.rs
LogicalMemoryProfile (Interface)
Types that provide logical memory profiling. Implementations should enumerate their "logical memory leaves" by calling [19 …
rust/ommx/src/logical_memory.rs
Evaluate (Interface)
Evaluate with a [State] [11 implementers]
rust/ommx/src/evaluate.rs
Stage (Interface)
Trait that defines the stage-specific data a constraint carries at each lifecycle phase. The type parameter `C` is the [12 …
rust/ommx/src/constraint/stage.rs
Core symbols most depended-on inside this repo
mapcalled by 576
rust/ommx/src/sampled.rs
insert
called by 331
rust/ommx/src/experiment/parameter.rs
context
called by 297
rust/ommx/src/parse.rs
binary
called by 223
python/ommx/src/decision_variable.rs
from_components
called by 213
python/ommx/src/instance.rs
iter
called by 188
rust/ommx/src/sampled.rs
into_inner
called by 169
rust/ommx/src/atol.rs
into_iter
called by 157
rust/ommx/src/v1_io.rs
Shape
Languages
Rust78%
Python22%
TypeScript1%
Modules by API surface
python/ommx/src/experiment.rs157 symbols
python/ommx/src/instance.rs102 symbols
python/ommx/src/artifact.rs100 symbols
python/ommx-tests/tests/test_experiment.py93 symbols
rust/ommx/src/artifact/manifest.rs92 symbols
rust/ommx/src/constraint_type.rs87 symbols
rust/ommx/src/experiment/dynamic/mod.rs84 symbols
rust/ommx/src/solution.rs74 symbols
rust/ommx/src/experiment/tests.rs59 symbols
rust/ommx/src/sample_set.rs58 symbols
rust/ommx/src/artifact/local_registry/registry.rs58 symbols
rust/ommx/src/decision_variable/table.rs57 symbols