Inconsistent config filename, param names and default values
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:
cache_allowedConfig.java#L74cache_directoryConfig.java#L79api_keyConfig.java#L120serverConfig.java#L127tagsConfig.java#L131
The following projects doesn't support a config file:
- .NET (OpenMlConnector.cs#L33 (
OpenMlConnectorconstructor)) - Weka (pom.xml#L106-L110, (
OpenmlConnectorconstructor))
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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