diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index ab83aef5c..c14bd07d0 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3351bc36d..688dbd7a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ This document describes the workflow on how to contribute to the openml-python package. If you are interested in connecting a machine learning package with OpenML (i.e. -write an openml-python extension) or want to find other ways to contribute, see [this page](https://openml.github.io/openml-python/master/contributing.html#contributing). +write an openml-python extension) or want to find other ways to contribute, see [this page](https://openml.github.io/openml-python/main/contributing.html#contributing). Scope of the package -------------------- @@ -20,7 +20,7 @@ keep the number of potential installation dependencies as low as possible. Therefore, the connection to other machine learning libraries such as *pytorch*, *keras* or *tensorflow* should not be done directly inside this package, but in a separate package using the OpenML Python connector. -More information on OpenML Python connectors can be found [here](https://openml.github.io/openml-python/master/contributing.html#contributing). +More information on OpenML Python connectors can be found [here](https://openml.github.io/openml-python/main/contributing.html#contributing). Reporting bugs -------------- @@ -100,7 +100,7 @@ local disk: $ git checkout -b feature/my-feature ``` - Always use a ``feature`` branch. It's good practice to never work on the ``master`` or ``develop`` branch! + Always use a ``feature`` branch. It's good practice to never work on the ``main`` or ``develop`` branch! To make the nature of your pull request easily visible, please prepend the name of the branch with the type of changes you want to merge, such as ``feature`` if it contains a new feature, ``fix`` for a bugfix, ``doc`` for documentation and ``maint`` for other maintenance on the package. 4. Develop the feature on your feature branch. Add changed files using ``git add`` and then ``git commit`` files: diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 47a5741e6..f0bee81e0 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/doc/contributing.rst b/doc/contributing.rst index e87a02dfb..c8fd5347a 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -10,7 +10,7 @@ Contribution to the OpenML package is highly appreciated in all forms. In particular, a few ways to contribute to openml-python are: * A direct contribution to the package, by means of improving the - code, documentation or examples. To get started, see `this file `_ + code, documentation or examples. To get started, see `this file `_ with details on how to set up your environment to develop for openml-python. * A contribution to an openml-python extension. An extension package allows OpenML to interface @@ -19,13 +19,13 @@ In particular, a few ways to contribute to openml-python are: For more information, see the :ref:`extensions` below. * Bug reports. If something doesn't work for you or is cumbersome, please open a new issue to let - us know about the problem. See `this section `_. + us know about the problem. See `this section `_. * `Cite OpenML `_ if you use it in a scientific publication. * Visit one of our `hackathons `_. - * Contribute to another OpenML project, such as `the main OpenML project `_. + * Contribute to another OpenML project, such as `the main OpenML project `_. .. _extensions: diff --git a/doc/progress.rst b/doc/progress.rst index 05b4b64c4..1ed7d4d2f 100644 --- a/doc/progress.rst +++ b/doc/progress.rst @@ -8,9 +8,11 @@ Changelog 0.12.2 ~~~~~~ + * ADD #1065: Add a ``retry_policy`` configuration option that determines the frequency and number of times to attempt to retry server requests. * 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). diff --git a/doc/usage.rst b/doc/usage.rst index b69e3530a..7abaacb10 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -40,7 +40,8 @@ directory of the user and is called config. It consists of ``key = value`` pairs which are separated by newlines. The following keys are defined: * apikey: - * required to access the server. The `OpenML setup `_ describes how to obtain an API key. + * required to access the server. The :ref:`sphx_glr_examples_20_basic_introduction_tutorial.py` + describes how to obtain an API key. * server: * default: ``http://www.openml.org``. Alternatively, use ``test.openml.org`` for the test server. @@ -76,11 +77,8 @@ Docker It is also possible to try out the latest development version of ``openml-python`` with docker: - ``docker run -it openml/openml-python`` - - See the `openml-python docker documentation `_ for more information. ~~~~~~~~~~~~ diff --git a/docker/startup.sh b/docker/startup.sh index 4c4a87776..2a75a621c 100644 --- a/docker/startup.sh +++ b/docker/startup.sh @@ -59,7 +59,7 @@ fi source /omlp/venv/bin/activate cd $code_dir -# The most recent ``master`` is already installed, but we want to update any outdated dependencies +# The most recent ``main`` is already installed, but we want to update any outdated dependencies pip install -e .[test,examples,docs,examples_unix] if [ "$1" == "test" ]; then diff --git a/examples/30_extended/custom_flow_.py b/examples/30_extended/custom_flow_.py index 1259acf57..ae5f37631 100644 --- a/examples/30_extended/custom_flow_.py +++ b/examples/30_extended/custom_flow_.py @@ -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 `_ 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. @@ -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 `_. # 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. diff --git a/examples/40_paper/2015_neurips_feurer_example.py b/examples/40_paper/2015_neurips_feurer_example.py index 721186016..3960c3852 100644 --- a/examples/40_paper/2015_neurips_feurer_example.py +++ b/examples/40_paper/2015_neurips_feurer_example.py @@ -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 ~~~~~~~~~~~ diff --git a/openml/cli.py b/openml/cli.py index 15654cfc6..cfd453e9f 100644 --- a/openml/cli.py +++ b/openml/cli.py @@ -331,7 +331,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"]]