CLN: Refactor window dataset, add tests #654
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Refactor:
- Refactor into sub-package with two modules:
`class_` module with `WindowDataset` class,
and module with `helper` functions
- Rename vectors + parameters `spect_id`, `spect_inds_vector`,
`x_inds` -> `source_ids`, `source_inds`, `window_inds`
- use helper functions in `vak.core.learncurve.train_dur_csv_paths`
- rewrite docstrings, add type hints to signatures
Write tests
- Define ALL_GENERATED_LEARNCURVE_CONFIGS as constant
in fixtures/config.py to be able to import elsewhere
- Define GENERATED_RESULTS_DATA_ROOT as constant
in fixtures/test_data.py to be able to import elsewhere
- Remove constants in tests/test_core/test_train_dur_csv_paths.py
Not needed after adding defaults for `spect_key`
and `timebins_key` in `vak.core.learncurve.train_dur_csv_paths`
- Add fixtures for testing WindowDataset.
To test WindowDataset we need to get the path
to a previous run of learncurve so we have
examples of the vectors used to represent
windows in a dataset.
- Add hard-coded list MODELS to fixtures/model.py
- Add fixtures/results.py with constants,
GENERATED_LEARNCURVE_RESULTS
- Add tests/test_datasets/test_window_dataset/
- Revise docstrings, add type hints, defaults
in learncurve/train_dur_csv_paths.py
- CLN: Used named kwargs in places in core/learncurve/
In learncurve.py and train_dur_csv_paths.py,
to avoid passing wrong value to wrong parameter.
- CLN: Rename module/function in vak/core/learncurve
- Rename `vak.core.learncurve.train_dur_csv_paths` -> `splits`
because what we care about are the splits themselves,
not the fact they are represented as csv paths
and organized by training set durations
- Rename `_dict_from_dur` to `from_previous_run_path`
since this is what the function really does and
there's no need to have it be "private"
- Move the two test modules into tests/test_core/test_learncurve/
and rename test_learncurve/test_train_dur_csv_paths ->
test_learncurve/test_splits
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #653