Skip to content

[DOC] Improve Development Setup Instructions #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PGijsbers merged 3 commits into from
Feb 18, 2026
Merged

[DOC] Improve Development Setup Instructions #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd865cf
[DOC] Improve Development Setup Instructions
jgyasu Dec 15, 2025
926cc2e
update
jgyasu Dec 15, 2025
6d83501
Update introduction with current state of the repository
PGijsbers Feb 18, 2026
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
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# services
Overview of all OpenML components including a docker-compose to run OpenML services locally
# Backend
Overview of all OpenML components including a docker-compose to run OpenML services locally.
The Python-based REST API (or REST API version 2) is still experimental, the other services are used in production.

Note: For the development of the Python-based REST API, a separate definition of services is currently maintained. These are in that repository, see the [Python REST API](https://docs.openml.org/apiv2/contributing/contributing/) documentation for more information.

## Overview

Expand All @@ -10,6 +13,13 @@ Overview of all OpenML components including a docker-compose to run OpenML servi
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/) version 2.21.0 or higher

## Cloning `services` repository

Clone the repo from GitHub:
```bash
git clone https://github.com/openml/services.git
```

## Usage

When using this project for the first time, run:
Expand Down