Skip to content

[DOC] Update documentation for running tests with local services - #1728

Open
yyr-465 wants to merge 1 commit into
openml:mainfrom
yyr-465:doc/issue-1708-local-services
Open

[DOC] Update documentation for running tests with local services#1728
yyr-465 wants to merge 1 commit into
openml:mainfrom
yyr-465:doc/issue-1708-local-services

Conversation

@yyr-465

@yyr-465 yyr-465 commented Jul 30, 2026

Copy link
Copy Markdown

Metadata

Details

This pull request updates the contributor documentation for running tests against local OpenML services.

Changes:

  • Document the required permissions for the local data and logs directories.
  • Document the Docker Compose profiles required to start the local services.
  • Document the OPENML_USE_LOCAL_SERVICES environment variable.
  • Add pytest commands for Linux/macOS and Windows PowerShell.
  • Add local service verification and cleanup instructions.

This addresses the documentation gap introduced by the switch to Docker-based local services in #1697.