openml / openml/OpenML

Give full schema in docs?

Open
#557 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

document it High priority
Dominant language
PHP
Stars
755
Forks
128
PR merge metrics
No merged PRs in 30d

Description

From @amueller on July 26, 2017 19:25

I think it would be helpful to list the full schema of the OpenML database(s) in the docs.
Even more than the formal scheme, it would be good to know what the legal values are for the string fields, if applicable.

Copied from original issue: openml/website#163

Contributor guide

Open the contributing guide

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

No file, test, or documentation entry point is named. Start by locating the existing OpenML documentation and database schema sources, then define the scope for documenting the full schema and applicable legal string values. Done means the relevant documentation covers both areas; confirm scope with maintainers first because the issue has had no response for years.

Written by the indexing model from the issue text.

Assessment

Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.