openml / openml/OpenML

Inconsistent config filename, param names and default values

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

Nobody has claimed this yet.

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

Description

The loaded config and named parameters are inconsistent over all projects.
Shouldn't they be standardised 🤔? If so, what's the right filename and params?

  • ~/.openml/config (file) and ~/.openml/cache(directory)?
  • apikey, server=https://www.openml.org/api, cachedir=~/.openml/cache?

What do you think?


R
Path (saveOMLConfig.R#L18): ~/.openml/config
Params (config_helpers.R#L20-L25):

server = "http://www.openml.org/api/v1",
cachedir = file.path(tempdir(), "cache"),
verbosity = 1L,
arff.reader = "farff",
apikey = "",
confirm.upload = TRUE

Python
Path (config.py#L26): ~/.openml/config
Params (config.py#L19-L23):

'apikey': None,
'server': "https://www.openml.org/api/v1/xml",
'verbosity': 0,
'cachedir': os.path.expanduser('~/.openml/cache'),
'avoid_duplicate_runs': 'True',

Java
Path (saveOMLConfig.R#L18): ~/.openml/openml.conf
Params:


The following projects doesn't support a config file:

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

Start by comparing R/saveOMLConfig.R and R/config_helpers.R, Python's openml/config.py, Java's Config.java, and the OpenMlConnector constructors in .NET and Weka. Define the cross-client filename, parameter names, defaults, and support expectations, then verify that the affected projects follow the agreed convention.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, java, python, r
Domain
developer-experience, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.