aims-umich / aims-umich/pyMAISE

Make tuner and postprocessor dictionaries more friendly to users

Offen
#77 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation enhancement
Vorherrschende Sprache
Python
Sterne
33
Forks
14
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

## Background
Currently the models and their hyperparameter distributions are defined using dictionaries. While this makes sense to someone familiar with pyMAISE this may make attempting to understand how to build a new model confused. There may be a more object oriented approach here; however, I think this will touch a lot of the documentation.

## Tasks
- [ ] Update `pyMAISE/tuner.py` and `pyMAISE/postprocessor.py to use new input structure.
- [ ] Update all relevant docs in `docs/source/` including benchmarks.

## Definition of Done
The new input for users is more friendly to users (not dictionaries) and the documentation reflects the changes.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.