search

NVIDIA / NeMo-Run

A tool to configure, launch and manage your machine learning experiments.
Apache License 2.0
78 stars 20 forks source link

Fix pitfalls and type annotation errors in README docs #25

Closed malcolmgreaves closed 3 months ago

malcolmgreaves commented 3 months ago

Fixes a few Python pitfalls with having mutable default function parameters. [1] Updates type annotations and docstrings to agree with the listed values. Removes redundant type listing for arguments in docstrings as the types are already annotated.

[1] https://docs.python-guide.org/writing/gotchas/#mutable-default-arguments

malcolmgreaves commented 3 months ago

👋 Hi y'all! I was looking over the NeMo run documentation since we're integrating it into BioNeMo. I have a few suggestions for the documentation here.