Merge branch 'main' into feature/list-estimation-procedure-ids-1750

Author: Jayant-kernel

.github/workflows/dist.yaml

@@ -6,14 +6,12 @@ on:
   push:
     branches:
       - main
-      - develop
     tags:
       - "v*.*.*"
 
   pull_request:
     branches:
       - main
-      - develop
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

.github/workflows/docs.yaml

@@ -5,14 +5,12 @@ on:
   push:
     branches:
       - main
-      - develop
     tags:
       - "v*.*.*"
 
   pull_request:
     branches:
       - main
-      - develop
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -40,7 +38,7 @@ jobs:
           CI: false
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PAGES_BRANCH: gh-pages
-        if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
+        if: contains(github.ref, 'main') && github.event_name == 'push'
         run: |
           git config user.name doc-bot
           git config user.email doc-bot@openml.com

.github/workflows/release_docker.yaml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
   push:
     branches:
-      - 'develop'
+      - 'main'
       - 'docker'
     tags:
       - 'v*'

.github/workflows/test.yml

@@ -7,14 +7,12 @@ on:
   push:
     branches:
       - main
-      - develop
     tags:
       - "v*.*.*"
 
   pull_request:
     branches:
       - main
-      - develop
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -100,7 +98,7 @@ jobs:
         if [[ "$major" -gt 1 ]] || { [[ "$major" -eq 1 ]] && [[ "$minor" -ge 7 ]]; }; then
           pip install "pandas==3.*"
         else
-          pip install "pandas==2.*"
+          pip install "pandas==2.*" "pyarrow<26"
         fi
 
     - name: Store repository status
@@ -196,7 +194,10 @@ jobs:
 
     - name: Cleanup Docker setup
       if: always() && steps.clone-services.outcome == 'success'
+      working-directory: ./services
       run: |
+        docker compose --profile rest-api --profile minio --profile evaluation-engine down -v
+        cd ..
         sudo rm -rf services
 
     - name: Check for files left behind by test

CITATION.cff

@@ -1,5 +1,12 @@
 cff-version: 1.2.0
-message: "If you use this software in a publication, please cite the metadata from preferred-citation."
+title: "OpenML Python"
+message: "If you use this software in a publication, please cite the metadata from 'preferred-citation'."
+type: software
+license: "BSD-3-Clause"
+repository-code: "https://github.com/openml/openml-python"
+url: "https://openml.github.io/openml-python/"
+authors:
+  - name: "OpenML-Python Contributors"
 preferred-citation:
   type: article
   authors:

CONTRIBUTING.md

@@ -153,8 +153,7 @@ in the PR description.
 
 The preferred workflow for contributing to openml-python is to
 fork the [main repository](https://github.com/openml/openml-python) on
-GitHub, clone, check out the branch `main`, and develop on a new branch
-branch. Steps:
+GitHub, clone, and develop on a new branch:
 
 0. Make sure you have git installed, and a GitHub account.
 
@@ -171,12 +170,6 @@ local disk:
    cd openml-python
    ```
 
-3. Switch to the ``develop`` branch:
-
-   ```bash
-   git checkout main
-   ```
-
 3. Create a ``feature`` branch to hold your development changes:
 
    ```bash

README.md

@@ -17,6 +17,7 @@
 [![Latest Release](https://img.shields.io/github/v/release/openml/openml-python)](https://github.com/openml/openml-python/releases)
 [![Python Versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://pypi.org/project/openml/)
 [![Downloads](https://static.pepy.tech/badge/openml)](https://pepy.tech/project/openml)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.PLACEHOLDER.svg)](https://doi.org/10.5281/zenodo.PLACEHOLDER)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 <!-- Add green badges for CI and precommit -->
 

docker/readme.md

@@ -44,10 +44,10 @@ docker run -v PATH/TO/FILE:/openml/MY_SCRIPT.py openml/openml-python MY_SCRIPT.p
 You can run the unit tests by passing `test` as the first argument.
 It also requires a local or remote repository to be specified, which is explained 
 [below]((#using-local-or-remote-code). For this example, we specify to test the
-`develop` branch:
+`my-feature` branch:
 
 ```text
-docker run openml/openml-python test develop
+docker run openml/openml-python test my-feature 
 ```
 
 ### Building documentation
@@ -56,16 +56,16 @@ You can build the documentation by passing `doc` as the first argument,
 you should [mount]((https://docs.docker.com/storage/bind-mounts/#start-a-container-with-a-bind-mount)) 
 an output directory in which the docs will be stored. You also need to provide a remote
 or local repository as explained in [the section below]((#using-local-or-remote-code).
-In this example, we build documentation for the `develop` branch.
+In this example, we build documentation for the `my-feature` branch.
 On Windows:
 
 ```text
-    docker run --mount type=bind,source="E:\\files/output",destination="/output" openml/openml-python doc develop
+    docker run --mount type=bind,source="E:\\files/output",destination="/output" openml/openml-python doc my-feature 
 ```
 
 on Linux:
 ```text
-    docker run --mount type=bind,source="./output",destination="/output" openml/openml-python doc develop
+    docker run --mount type=bind,source="./output",destination="/output" openml/openml-python doc my-feature 
 ```
 
 see [the section below]((#using-local-or-remote-code) for running against local changes

docs/details.md

@@ -5,17 +5,17 @@ This document highlights some of the more advanced features of
 
 ## Configuration
 
-The configuration file resides in a directory `.config/openml` in the
+The configuration file resides in a directory `~/.config/openml` in the
 home directory of the user and is called config (More specifically, it
-resides in the [configuration directory specified by the XDGB Base
+resides in the [configuration directory specified by the XDG Base
 Directory
 Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)).
 It consists of `key = value` pairs which are separated by newlines. The
 following keys are defined:
 
 - apikey: required to access the server.
-- server: the server to connect to (default: `http://www.openml.org`).
-          For connection to the test server, set this to `test.openml.org`.
+- server: the server to connect to (default: `https://www.openml.org`).
+          For connection to the test server, set this to `https://test.openml.org`.
 - cachedir: the root folder where the cache file directories should be created.
     If not given, will default to `~/.openml/cache`
 - avoid_duplicate_runs: if set to `True` (default), when certain functions

docs/extensions.md

@@ -27,8 +27,8 @@ to upload it. However, in order to simplify the process of uploading
 flows and runs from a specific library, an additional interface can be
 built. The OpenML-Python team does not have the capacity to develop and
 maintain such interfaces on its own. For this reason, we have built an
-extension interface to allows others to contribute back. Building a
-suitable extension for therefore requires an understanding of the
+extension interface to allow others to contribute back. Building a
+suitable extension therefore requires an understanding of the
 current OpenML-Python support.
 
 [This tutorial](../examples/Basics/simple_flows_and_runs_tutorial) shows how the scikit-learn 
@@ -65,8 +65,8 @@ and can be implemented in several lines of code.
         Typically, the flow-dependency field is used to check whether
         the specific library is present, and no unknown libraries are
         present there.
-    -   `can_handle_model`: Similar as
-        `can_handle_flow`:, except that in
+    -   `can_handle_model`: Similar to
+        `can_handle_flow`, except that in
         this case a Python object is given. As such, in many cases, this
         method can be implemented by checking whether this adheres to a
         certain base class.
@@ -138,7 +138,7 @@ Each extension created should be a stand-alone repository, compatible
 with the [OpenML-Python repository](https://github.com/openml/openml-python). 
 The extension repository should work off-the-shelf with *OpenML-Python* installed.
 
-Create a public Github repo with the following directory structure:
+Create a public GitHub repo with the following directory structure:
 
     | [repo name]
     |    |-- [extension name]
@@ -149,7 +149,7 @@ Create a public Github repo with the following directory structure:
 ### Recommended
 
 -   Test cases to keep the extension up to date with the
-    Openml-Python upstream changes.
+    OpenML-Python upstream changes.
 -   Documentation of the extension API, especially if any new
     functionality added to OpenML-Python\'s extension design.
 -   Examples to show how the new extension interfaces and works with