Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cfg dataset; better assertions and comments #31

Merged
merged 7 commits into from
Jul 1, 2024
Merged

Conversation

arturtoshev
Copy link
Member

  • make dataset a group of config parameters
  • improve usability with better assertions and comments

Copy link

codecov bot commented Jun 26, 2024

Codecov Report

Attention: Patch coverage is 91.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.1%. Comparing base (6428cff) to head (9f1f397).

Files Patch % Lines
lagrangebench/data/data.py 50.0% 1 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff          @@
##            main     #31   +/-   ##
=====================================
  Coverage   82.1%   82.1%           
=====================================
  Files         25      25           
  Lines       1680    1686    +6     
=====================================
+ Hits        1380    1385    +5     
- Misses       300     301    +1     
Flag Coverage Δ
unittests 82.1% <91.6%> (+<0.1%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Show resolved Hide resolved
Copy link
Member

@gerkone gerkone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not disrupt anything, so fine by me. In the end you didn't change the logic of the dataset class. Should we speity in the docstring to the dataset that download starts if the directory does not exist?

  dataset_path: Path to the dataset. Download will start automatically if dataset_path does not exist.

@arturtoshev
Copy link
Member Author

Does not disrupt anything, so fine by me. In the end you didn't change the logic of the dataset class. Should we speity in the docstring to the dataset that download starts if the directory does not exist?

  dataset_path: Path to the dataset. Download will start automatically if dataset_path does not exist.

there you go: 9f1f397

@arturtoshev arturtoshev merged commit 80d549a into main Jul 1, 2024
6 checks passed
@arturtoshev arturtoshev deleted the cfg_dataset branch July 1, 2024 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants