openml / openml/server-api

Document list of client-side evaluation names

Open Beginner friendly
#337 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

behavior
Dominant language
Python
Stars
16
Forks
50
PR merge metrics
No merged PRs in 30d

Description

We should clearly explain how clients should upload their own evaluations, e.g. runtimes, and what happens exactly when they upload their own measures. For instance, if you upload a measure that OpenML also computes, a warning will be stored.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing documentation for client uploads and evaluation names. Document how clients upload their own evaluations, including runtimes and measures, and explain the warning stored when an uploaded measure is also computed by OpenML; done means the upload behavior is clear to clients.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.