Skip to main content

Next-generation Experiment Management Platform for Operations Research

Project description

ORruns: Redefining Operations Research Experiment Management ๐Ÿš€

ORruns Logo
Next-generation Experiment Management Platform for Operations Research

๐ŸŒฑ ORruns is in its vibrant early stages. As a newly launched open-source project, we welcome every Operations Research researcher to participate and contribute. Your ideas and code will help this project grow better. Let's build the future of the Operations Research community together!

Quick Start โ€ข Why ORruns โ€ข Community โ€ข Features


Why ORruns?

Have you encountered these challenges in Operations Research?

  • ๐Ÿ“Š Experimental data scattered everywhere, difficult to manage and track
  • ๐Ÿ”„ Tedious experiment repetition and chaotic parameter management
  • ๐Ÿ“ˆ Repetitive code writing for visualization
  • ๐Ÿค Lack of unified experiment management and sharing platform

ORruns is born to solve these problems! We are committed to providing Operations Research researchers with a modern, intuitive, and powerful experiment management tool.

โœจ Features

Elegant Experiment Tracking

Simple Single-Run Experiment

@repeat_experiment(times=1)
def optimize_with_different_seeds(tracker):
    tracker.log_params({
        "epoches": 1000
    })
    # Your optimization code
    result = optimize()
    # Automatic parallelization, result collection and visualization
    return your_optimization_algorithm()

Powerful Parallel Experiment Support

@repeat_experiment(times=10, parallel=True)
def optimize_with_different_seeds(tracker):
    tracker.log_params({
        "population_size": 100,
        "generations": 1000
    })
    
    # Your optimization code
    result = optimize()
    
    tracker.log_metrics({
        "pareto_front_size": len(result.pareto_front),
        "hypervolume": result.hypervolume
    })
    # save the Pareto front Visualization
    tracker.log_artifact("pareto_front.png", plt.gcf())
    # Automatic parallelization, result collection and visualization
    return your_optimization_algorithm()

Intuitive Visualization Interface

Dashboard Screenshot

๐Ÿš€ Quick Start

pip install orruns

Check out our Quick Start Guide to begin your first experiment!

๐Ÿš€ Making Operations Research Better

We believe that the Operations Research community deserves modern and open tooling ecosystems like those in the machine learning community. ORruns is not just a tool, but a vision - let's together:

  • ๐ŸŒŸ Build an open, active Operations Research community
  • ๐Ÿ”ง Create better experiment management tools
  • ๐Ÿ“š Share knowledge and best practices
  • ๐Ÿค Promote academic exchange and collaboration

๐Ÿ’ก Join the Journey

"The future of Operations Research needs our collective effort. Let's build an open-source community for Operations Research researchers!"

๐ŸŒฑ Growing Together from Zero

ORruns is still a young project, which means:

  • You can participate in core feature design and development
  • Your ideas and suggestions are more likely to be adopted
  • You can witness and influence every step of the project's growth
  • You'll be among the earliest contributors

๐Ÿ’ช How to Contribute

Whether you are:

  • ๐ŸŽ“ A student new to Operations Research
  • ๐Ÿ‘จโ€๐Ÿ”ฌ An experienced researcher
  • ๐Ÿ‘ฉโ€๐Ÿ’ป A passionate developer
  • ๐Ÿ“š An enthusiastic documentation writer

We welcome your participation:

  • ๐ŸŽฏ Use and Feedback: Every suggestion drives ORruns to become better
  • ๐Ÿ› ๏ธ Development: Whether fixing bugs or adding features, all contributions are welcome
  • ๐Ÿ“ Documentation: Help others understand and use ORruns
  • ๐ŸŒ Promotion: Spread the word to more Operations Research researchers

๐ŸŽฏ Roadmap

We're planning exciting features to build a more comprehensive Operations Research experiment ecosystem:

Coming Soon

  • ๐Ÿ“Š Enhanced Analytics (v0.2.0)

    • Dynamic Pareto Front Visualization
    • Advanced Statistical Analysis Tools
    • Experiment Comparison System
  • ๐Ÿ› ๏ธ Improved User Experience (v0.3.0)

    • Experiment Backup and Recovery
    • Publication-Ready Results Export
    • Powerful Command Line Tools

Check out the complete roadmap document for more details and future plans!

๐Ÿ“„ License

ORruns is licensed under the GNU General Public License v3.0 (GPL-3.0) with additional non-commercial terms. This means: if you need to use this software for commercial purposes, please contact the project maintainers for a commercial license. See the full license text in the LICENSE file.

โ˜• Support the Project


Buy Me A Coffee

๐ŸŒŸ Join the Community

By Operations Researchers, For Operations Researchers

If you like this project, please give us a โญ๏ธ

Project details


Download files

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

Source Distribution

orruns-0.1.2.tar.gz (40.5 kB view details)

Uploaded Source

Built Distribution

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

orruns-0.1.2-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

Details for the file orruns-0.1.2.tar.gz.

File metadata

  • Download URL: orruns-0.1.2.tar.gz
  • Upload date:
  • Size: 40.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for orruns-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ea6bff57fbe67ebe2b5863568eefb8b00d01764bd87a4e450fcd36794ab88f25
MD5 7633e090a6fd58d741897e46e9604646
BLAKE2b-256 994cf4bd9e0aa3b5fb88be65039d66fef1e6203fda5d42b4906ff1b831ce45ec

See more details on using hashes here.

File details

Details for the file orruns-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: orruns-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 43.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for orruns-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 237ece04d85c6e8bafa29c8f9eefce4760bd66c1be7774f7f2b65bf5449ff85a
MD5 fc3d3c9b7e8e12c5721dbfafab1a85ee
BLAKE2b-256 e0292590b3597301a1eb6f5620dceea32da1c3dd3cc3c4b1aa35aeadc9d4ca02

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page