Welcome to ddop!
ddop is a Python library for data-driven operations management. The goal of ddop is to provide well-established
data-driven operations management tools within a programming environment that is accessible and easy to use even
for non-experts. At the current state ddop contains well known data-driven newsvendor models, a set of
performance metrics that can be used for model evaluation and selection, as well as datasets that are useful to
quickly illustrate the behavior of the various algorithms implemented in ddop or as benchmark for testing new
models. Through its consistent and easy-to-use interface one can run and compare provided models with only a few
lines of code.
Installation
ddop is available via PyPI using:
pip install ddop
The installation requires the following dependencies:
numpy==1.18.2
scipy==1.4.1
pandas==1.1.4
statsmodels==0.11.1
scikit-learn==0.23.0
tensorflow==2.4.1
pulp==2.0
mpmath
Note: The package is actively developed and conflicts with other packages may occur during installation. To avoid any installation conflicts we therefore recommend to install the package in an empty environment with the above mentioned dependencies
Quickstart
ddop provides a varity of newsvendor models. The following example
shows how to use one of these models for decision making. It assumes
a very basic knowledge of data-driven operations management practices.
As first step we initialize the model we want to use. In this example LinearRegressionNewsvendor.
>>> from ddop.newsvendor import LinearRegressionNewsvendor
>>> mdl = LinearRegressionNewsvendor(cu=2,co=1)
A model can take a set of parameters, each describing the model or the optimization
problem it tries to solve. Here we set the underage costs cu to 2 and
the overage costs co to 1.
As next step we load the Yaz Dataset and split it into train and test set.
>>> from ddop.datasets import load_yaz
>>> from sklearn.model_selection import train_test_split
>>> X, y = load_yaz(one_hot_encoding=True, return_X_y=True)
>>> X_train, X_test, y_train, y_test = train_test_split(X, y, shuffle=False, random_state=0)
After the model is initialized, the fit method can be used to learn a decision model from the training data X_train, y_train.
>>> mdl.fit(X_train, y_train)
We can then use the predict method to make a decision for new data samples.
>>> mdl.predict(X_test)
>>> array([[ 8.32.., 7.34.., 16.92.., ..]])
To get a representation of the model’s decision quality we can use the score function, which takes as input
X_test and y_test. The score function makes a decision for each sample in X_test and calculates
the negated average costs with respect to the true values y_test and the overage and underage costs.
>>> mdl.score(X_test,y_test)
-7.05..
See also
Follow the API reference to get an overview of available functionalities and for detailed class and function information.
To get familiar with ddop and to learn more about data-driven operations management check out our Tutorials.