Clean up docstrings and add doctests where appropriate

Oufattole / meds-torch

MIT License

15 stars 1 forks source link

Clean up docstrings and add doctests where appropriate #87

Open mmcdermott opened 1 month ago

mmcdermott commented 1 month ago

[ ] docstring spacing is all messed up.
[ ] docstrings are in numpy style; google style would be better
[ ] doctests should be added throughout
[ ] unittests tests are more like a hybrid hypothesis/integration test at the moment, we need to isolate tests to be more specific

Oufattole commented 3 weeks ago

For doctests, we should add a helper in the pytorch_dataset class that generates dummy data (so an NRT shard with dynamic data and a schema parquet with static data), and call this dummy data function in the doctests to initialize the file paths the dataset relies on. We can also inject an omegaconf dict with the necessary parameters.