Skip to main content
Ctrl+K
OMMX 3.0.0b9 documentation - Home OMMX 3.0.0b9 documentation - Home

Get started

  • Install the Python SDK and adapters

Examples

  • Sampling from QUBO with OMMX Adapter
  • Solve a published benchmark and compare its result

Adapter development

  • Implementing an OMMX Adapter

Transform problems and connect solvers

  • Transform a problem and connect it to a solving method

Evaluate candidates and interpret results

  • Evaluate candidates and interpret results

Save and share problems, results, and trials

  • Save and share problems, results, and trials

User Guide

  • Install and Run the OMMX CLI
  • Inspect saved Artifacts and manage the Local Registry
  • Share an Artifact through a registry
  • Install OMMX Agent Plugins and Skills
  • Adapter-specific Diagnostics
  • Tracing and Profiling

API Reference

  • OMMX Python SDK API Reference
    • ommx
      • Sense
      • Equality
      • Kind
      • DecisionVariableRole
      • Optimality
      • Relaxation
      • State
      • Samples
      • Bound
      • BridgeError
      • ExactIntegerSlackError
      • InfeasibleDetected
      • LogEncodingError
      • PreparationTargetNotReachedError
      • Sos1BigMPromotionBatchRejectedError
      • Linear
      • Quadratic
      • Polynomial
      • Function
      • OutputObjective
      • DecisionVariable
      • AttachedDecisionVariable
      • Parameter
      • ConstraintKind
      • PolynomialRequirement
      • InstanceClassClause
      • InstanceClass
      • InstanceClassMismatch
      • InstanceClassClauseReport
      • InstanceClassMembershipReport
      • SpecialConstraintPreparation
      • ObjectivePreparation
      • IntegerSlackPreparation
      • IntegerEncodingPreparation
      • BinaryPowerPreparation
      • FixedPenaltyPreparation
      • PreparationPolicy
      • ConstraintCollection
      • ConstraintFamilyView
      • RemovedConstraintCollection
      • EvaluatedConstraintCollection
      • SampledConstraintCollection
      • ConstraintIDBase
      • ConstraintView
      • ConstraintID
      • IndicatorConstraintID
      • OneHotConstraintID
      • Sos1ConstraintID
      • Constraint
      • AttachedConstraint
      • IndicatorConstraint
      • AttachedIndicatorConstraint
      • RemovedIndicatorConstraint
      • OneHotConstraint
      • AttachedOneHotConstraint
      • RemovedOneHotConstraint
      • Sos1Constraint
      • AttachedSos1Constraint
      • RemovedSos1Constraint
      • Sos1BigMSelectorClaim
      • Sos1BigMPromotionRequest
      • Sos1BigMPromotion
      • RemovedConstraint
      • Provenance
      • ProvenanceKind
      • NamedFunction
      • EvaluatedDecisionVariable
      • EvaluatedConstraint
      • EvaluatedIndicatorConstraint
      • EvaluatedOneHotConstraint
      • EvaluatedSos1Constraint
      • EvaluatedNamedFunction
      • SampledDecisionVariable
      • SampledConstraint
      • SampledIndicatorConstraint
      • SampledOneHotConstraint
      • SampledSos1Constraint
      • SampledNamedFunction
      • Instance
      • ParametricInstance
      • Solution
      • SampleSet
      • Rng
      • get_default_atol
      • set_default_atol
      • VariableIDLike
      • ToState
      • NamedState
      • ToSamples
    • ommx.artifact
      • AnonymousArtifactRef
      • Artifact
      • ArtifactRef
      • ArchiveDescriptor
      • ArchiveManifest
      • ArtifactDraft
      • RemoteArtifactError
      • RemoteArtifactNotFoundError
      • RemoteArtifactAuthenticationError
      • RemoteArtifactAuthorizationError
      • RemoteArtifactTransportError
      • InvalidRemoteArtifactError
      • Descriptor
      • GcBlob
      • GcInvalidManifest
      • GcMissingBlob
      • GcReport
      • GcRoot
      • PruneAnonymousReport
      • gc
      • get_local_registry_root
      • list_artifacts
      • prune_anonymous
      • remove_image
      • restore_image
      • set_local_registry_root
      • get_images
    • ommx.experiment
      • AutosavePolicy
      • Experiment
      • ExperimentCheckpointRef
      • ExperimentRef
      • list_experiment_checkpoints
      • list_experiments
      • OpenSolve
      • Run
      • SealedRun
      • Solve
      • Sampling
    • ommx.adapter
    • ommx.cli
    • ommx.dataset
    • ommx.display
    • ommx.experiment.attachments
    • ommx.testing
      • ommx.testing.placement
    • ommx.mps
    • ommx.qplib
    • ommx.tracing
    • Adapter packages and input contracts
    • ommx_python_mip_adapter
      • ommx_python_mip_adapter.adapter
      • ommx_python_mip_adapter.exception
      • ommx_python_mip_adapter.python_mip_to_ommx
    • ommx_pyscipopt_adapter
      • ommx_pyscipopt_adapter.adapter
      • ommx_pyscipopt_adapter.exception
    • ommx_highs_adapter
      • ommx_highs_adapter.adapter
      • ommx_highs_adapter.exception
    • ommx_openjij_adapter
      • ommx_openjij_adapter.adapter

Migration Guide

  • Python SDK v2 to v3 Migration Guide
  • Python SDK v1 to v2 Migration Guide

Release Note

  • OMMX Python SDK 3.0.x
  • OMMX Python SDK 2.5.x
  • OMMX Python SDK 2.4.x
  • OMMX Python SDK 2.3.x
  • OMMX Python SDK 2.2.x
  • OMMX Python SDK 2.1.x
  • OMMX Python SDK 2.0.0
  • OMMX Python SDK 1.9.0
  • OMMX Python SDK 1.8.0
  • OMMX Python SDK 1.7.0
  • OMMX Python SDK 1.6.0
  • OMMX Python SDK 1.5.0

Python Module Index

o
 
o
- ommx
    ommx.adapter
    ommx.artifact
    ommx.cli
    ommx.dataset
    ommx.display
    ommx.experiment ommx.experiment records an optimization experiment as one OMMX Artifact.
    ommx.experiment.attachments
    ommx.mps
    ommx.qplib
    ommx.testing
    ommx.testing.placement
    ommx.tracing
- ommx_highs_adapter
    ommx_highs_adapter.adapter
    ommx_highs_adapter.exception
- ommx_openjij_adapter
    ommx_openjij_adapter.adapter
- ommx_pyscipopt_adapter
    ommx_pyscipopt_adapter.adapter
    ommx_pyscipopt_adapter.exception
- ommx_python_mip_adapter
    ommx_python_mip_adapter.adapter
    ommx_python_mip_adapter.exception
    ommx_python_mip_adapter.python_mip_to_ommx

By Jij Inc.

© Copyright 2024, Jij Inc..