Add possibility to install cpu only version of xgboost (OpenSTEF#597)

* add possiblity to install * add comment * update README * Fix typo * Update README.md Co-authored-by: Lars Schilders <[email protected]> Signed-off-by: Jan Maarten van Doorn <[email protected]> * revert commit --------- Signed-off-by: Jan Maarten van Doorn <[email protected]> Co-authored-by: Lars Schilders <[email protected]>
lf-energy-projects-renovation-state · Feb 27, 2025 · ecc22bd · ecc22bd
1 parent 75f7712
commit ecc22bd
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -5,11 +5,15 @@ SPDX-License-Identifier: MPL-2.0
 -->
 
 # OpenSTEF
+
 <!-- Badges -->
+
 [![Downloads](https://static.pepy.tech/badge/openstef)](https://pepy.tech/project/openstef)
 [![Downloads](https://static.pepy.tech/badge/openstef/month)](https://pepy.tech/project/openstef)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5585/badge)](https://bestpractices.coreinfrastructure.org/projects/5585)
+
 <!-- SonarCloud badges -->
+
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=bugs)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=code_smells)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=coverage)](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef)
@@ -23,19 +27,21 @@ SPDX-License-Identifier: MPL-2.0
 OpenSTEF is a Python package designed for generating short-term forecasts in the energy sector. The repository includes all the essential components required for machine learning pipelines that facilitate the forecasting process. To utilize the package, users are required to furnish their own data storage and retrieval interface.
 
 # Table of contents
+
 - [OpenSTEF](#openstef)
 - [Table of contents](#table-of-contents)
 - [External information sources](#external-information-sources)
 - [Installation](#installation)
 - [Usage](#usage)
-    - [Example notebooks](#example-notebooks)
-    - [Reference Implementation](#reference-implementation)
-    - [Database connector for OpenSTEF](#database-connector-for-openstef)
+  - [Example notebooks](#example-notebooks)
+  - [Reference Implementation](#reference-implementation)
+  - [Database connector for OpenSTEF](#database-connector-for-openstef)
 - [License](license)
 - [Contributing](#contributing)
 - [Contact](#contact)
 
 # External information sources
+
 - [Documentation website](https://openstef.github.io/openstef/index.html);
 - [Python package](https://pypi.org/project/openstef/);
 - [Linux Foundation project page](https://www.lfenergy.org/projects/openstef/);
@@ -53,9 +59,11 @@ pip install openstef
 ### Remark regarding installation within a **conda environment on Windows**
 
 A version of the pywin32 package will be installed as a secondary dependency along with the installation of the openstef package. Since conda relies on an old version of pywin32, the new installation can break conda's functionality. The following command can solve this issue:
+
 ```shell
 pip install pywin32==300
 ```
+
 For more information on this issue see the [readme of pywin32](https://github.com/mhammond/pywin32#installing-via-pip) or [this Github issue](https://github.com/mhammond/pywin32/issues/1865#issue-1212752696).
 
 ## Remark regarding installation on Apple Silicon
@@ -64,19 +72,31 @@ If you want to install the `openstef` package on Apple Silicon (Mac with M1-chip
 
 1. Run `brew install libomp` (if you haven’t installed Homebrew: [follow instructions here](https://brew.sh/))
 2. If your interpreter can not find the `libomp` installation in `/usr/local/bin`, it is probably in `/opt/brew/Cellar`. Run:
+
 ```sh
 mkdir -p /usr/local/opt/libomp/
 ln -s /opt/brew/Cellar/libomp/{your_version}/lib /usr/local/opt/libomp/lib
 ```
+
 3. Uninstall `xgboost` with `pip` (`pip uninstall xgboost`) and install with `conda-forge` (`conda install -c conda-forge xgboost`)
 4. If you encounter similar issues with `lightgbm`: uninstall `lightgbm` with `pip` (`pip uninstall lightgbm`) and install later version with `conda-forge` (`conda install -c conda-forge 'lightgbm>=4.2.0'`)
 
+### Remark regarding installation with minimal XGBoost dependency
+
+It is possible to install openSTEF with a minimal XGBoost (CPU-only) package. This only works on x86_64 (amd64) Linux and Windows platforms. Advantage is that significantly smaller dependencies are installed. In that case run:
+
+```shell
+pip install openstef[cpu]
+```
+
 # Usage
 
 ## Example notebooks
+
 To help you get started, a set of fundamental example notebooks has been created. You can access these offline examples [here](https://github.com/OpenSTEF/openstef-offline-example).
 
 ## Reference Implementation
+
 A complete implementation including databases, user interface, example data, etc. is available at: https://github.com/OpenSTEF/openstef-reference
 
 ![screenshot](https://user-images.githubusercontent.com/60883372/146760483-29af3ac7-62af-4f13-98c7-982a79c517d1.jpg)
@@ -90,17 +110,21 @@ python -m openstef task <task_name>
 ```
 
 ## Database connector for openstef
+
 This repository provides an interface to OpenSTEF (reference) databases. The repository can be found [here](https://github.com/OpenSTEF/openstef-dbc).
 
 # License
+
 This project is licensed under the Mozilla Public License, version 2.0 - see LICENSE for details.
 
 ## Licenses third-party libraries
+
 This project includes third-party libraries, which are licensed under their own respective Open-Source licenses. SPDX-License-Identifier headers are used to show which license is applicable. The concerning license files can be found in the LICENSES directory.
 
 # Contributing
+
 Please read [CODE_OF_CONDUCT.md](https://github.com/OpenSTEF/.github/blob/main/CODE_OF_CONDUCT.md), [CONTRIBUTING.md](https://github.com/OpenSTEF/.github/blob/main/CONTRIBUTING.md) and [PROJECT_GOVERNANCE.md](https://github.com/OpenSTEF/.github/blob/main/PROJECT_GOVERNANCE.md) for details on the process for submitting pull requests to us.
 
 # Contact
+
 Please read [SUPPORT.md](https://github.com/OpenSTEF/.github/blob/main/SUPPORT.md) for how to connect and get into contact with the OpenSTEF project
-
diff --git a/setup.py b/setup.py
@@ -18,6 +18,10 @@ def read_requirements_from_file():
                 line = line[: line.index("#")].strip()
             if len(line) == 0:
                 continue
+            if "xgboost" in line:
+                line = (
+                    line + '; extra == "gpu"'
+                )  # make sure xgboost is installed with GPU support when not specifying options
             requirements.append(line)
         return requirements
 
@@ -55,4 +59,10 @@ def read_long_description_from_readme():
         r"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
         "Programming Language :: Python :: 3.11",
     ],
+    extras_require={
+        "cpu": [
+            "xgboost-cpu~=2.0"
+        ],  # Add xgboost-cpu to avoid install large xgboost package when not using GPU
+        "gpu": ["xgboost"],  # Needed to install xgboost with GPU support in normal case
+    },
 )