Decision Optimization utilities for IBM Watson Studio projects
Project description
DSE_DO_Utils
Decision Optimization utilities for IBM Watson Studio Local and ICPd projects.
Source (GitHub)
Documentation (GitHubPages)
This repository contains the package dse_do_utils
. This can be installed using pip.
Main classes:
- ScenarioManager. Reads and writes table data from and to all combinations of csv-files, Excel spreadhseet and DO scenario.
- DataManager. A DataManager is mostly a container for data and functions for pre- and post-processing. Can be subclassed and stored in a script to be able to share code between multiple notebooks. Also contains some utilities for data manipulation, like the crossjoin.
- OptimizationEngine. Also mostly a container for functions around creating an optimization model and using the docplex APIs. Can be subclassed and stored in a script to be able to share code between multiple notebooks. Also contains some functions to create dvars and export .lp files.
- ScenarioPicker. Interactively pick an existing scenario from a drop-down menu in a notebook. Typically used in visualization notebooks.
- MapManager. For creating map visualizations using Folium.
- DeployedDOModel. Interfacing from Python to a deployed DO model.
Installation (CPDv2.5)
(For Cloud Pak for Data v2.5)
CPDv2.5 is very different from the previous versions and it has a significant impact on how the dse-do-utils can be installed and used.
Options:
- Install using pip in a customized environment. This applies to both Jupyter and JupyterLab.
- Install as a package in JupyterLab.
- Install as modules in Jupyter
- Install/use as modules in the DO Model Builder
Install in customized environment
CPDv2.5 allows for easy customization of environments. Add the following to the customization configuration:
- pip:
- dse-do-utils=0.3.0.0
This automatically downloads dse-do-utils from PyPI and installs the package.
For air-gapped systems that have no access to PyPI:
- Download the package from PyPI/Conda from an internet connected system as a wheel/zip file
- Upload the wheel/zip as a data asset
- Install package from wheel/zip
This downloads the package as a wheel/zip and puts it in the data assets
!pip download dse-do-utils -d /project_data/data_asset/
Then move the wheel/zip to the Data Assets (see the InstallationReadMe.md
for more details)
Next, set the environment customization to:
- pip:
- dse-do-utils --no-index --find-links=/project_data/data_asset/dse_do_utils-0.3.0.0.tar.gz
See the InstallationReadMe.md
for many more details on installation and usage in other cases.
Import
Then import the required classes from dse_do_utils
:
from dse_do_utils import ScenarioManager, DataManager
This is the basics. For many ore details on other usage, see InstallationReadMe.md
Target environments
To be used within:
- CPDv2.1 (version 0.2.2.3 is preferred. But version 0.3.0.0 should be backwards compatible.)
- CPDv2.5 (version 0.3.0.0 and up)
- WSLv1.2.3 with Python 2.7 (version 0.2.2.3 only)
Requirements
This package requires:
- dd-scenario. This package provides an interface to the DO scenarios. This package is only available within WSL and ICPd. It cannot be pip installed in other environments.
- docplex. This package interfaces with the CPLEX and CP Optimizer optimization engines.
- folium. Map visualization. Only for the MapManager.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dse_do_utils-0.3.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c7d59df1450a84e4b9649df365e7e44cf3e452a85478cb04246643537bc8af0 |
|
MD5 | 17b6e3ad5ffd3d53053eed71d67c8751 |
|
BLAKE2b-256 | b0990fa7e0a31750c8131c18a66091f39a57eb3ecfe90412e0c06884096dadf3 |