Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ jobs:
cd doc
make linkcheck
- name: Pull latest gh-pages
if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
run: |
cd ..
git clone https://github.com/openml/openml-python.git --branch gh-pages --single-branch gh-pages
- name: Copy new doc into gh-pages
if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
run: |
branch_name=${GITHUB_REF##*/}
cd ../gh-pages
rm -rf $branch_name
cp -r ../openml-python/doc/build/html $branch_name
- name: Push to gh-pages
if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
run: |
last_commit=$(git log --pretty=format:"%an: %s")
cd ../gh-pages
Expand Down
2 changes: 2 additions & 0 deletions doc/progress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ Changelog

0.12.2
~~~~~~

* ADD #1075: A docker image is now automatically built on a push to develop. It can be used to build docs or run tests in an isolated environment.
* DOC: Fixes a few broken links in the documentation.
* MAINT: Rename `master` brach to ` main` branch.
* MAINT/DOC: Automatically check for broken external links when building the documentation.
* MAINT/DOC: Fail documentation building on warnings. This will make the documentation building
fail if a reference cannot be found (i.e. an internal link is broken).
Expand Down
4 changes: 2 additions & 2 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ Docker

It is also possible to try out the latest development version of ``openml-python`` with docker:

```
.. code:: bash

docker run -it openml/openml-python
```


See the `openml-python docker documentation <https://github.com/openml/openml-python/blob/main/docker/readme.md>`_ for more information.
Expand Down
4 changes: 2 additions & 2 deletions examples/30_extended/custom_flow_.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
================================

The most convenient way to create a flow for your machine learning workflow is to generate it
automatically as described in the `Obtain Flow IDs <https://openml.github.io/openml-python/master/examples/30_extended/flow_id_tutorial.html#sphx-glr-examples-30-extended-flow-id-tutorial-py>`_ tutorial. # noqa E501
automatically as described in the :ref:`sphx_glr_examples_30_extended_flow_id_tutorial.py` tutorial.
However, there are scenarios where this is not possible, such
as when the flow uses a framework without an extension or when the flow is described by a script.

Expand All @@ -31,7 +31,7 @@
# 1. Defining the flow
# ====================
# The first step is to define all the hyperparameters of your flow.
# The API pages feature a descriptions of each variable of the `OpenMLFlow <https://openml.github.io/openml-python/master/generated/openml.OpenMLFlow.html#openml.OpenMLFlow>`_. # noqa E501
# The API pages feature a descriptions of each variable of the :class:`openml.flows.OpenMLFlow`.
# Note that `external version` and `name` together uniquely identify a flow.
#
# The AutoML Benchmark runs AutoML systems across a range of tasks.
Expand Down
2 changes: 1 addition & 1 deletion examples/40_paper/2015_neurips_feurer_example.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A tutorial on how to get the datasets used in the paper introducing *Auto-sklearn* by Feurer et al..

Auto-sklearn website: https://automl.github.io/auto-sklearn/master/
Auto-sklearn website: https://automl.github.io/auto-sklearn/

Publication
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion openml/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ def main() -> None:
parser_configure = subparsers.add_parser(
"configure",
description="Set or read variables in your configuration file. For more help also see "
"'https://openml.github.io/openml-python/master/usage.html#configuration'.",
"'https://openml.github.io/openml-python/main/usage.html#configuration'.",
)

configurable_fields = [f for f in config._defaults if f not in ["max_retries"]]
Expand Down