Remove defaults from docstrings. (#480)

This commit is contained in:
Matthew Tancik authored and GitHub committed 2022-09-19 10:04:25 -07:00
1 parent f796a9f468
commit 8b388a3e5c
25 files changed
+106 -112

No files matched your search

+1 -1
View File
@@ -18,7 +18,7 @@ def run_command(command: str, continue_on_fail: bool = False) -> bool:
Args:
command: command to run
continue_on_fail: whether to continue running commands if the current one fails. Defaults to False.
continue_on_fail: whether to continue running commands if the current one fails.
"""
ret_code = subprocess.call(command, shell=True)
if ret_code != 0:
+1 -2
View File
@@ -110,8 +110,7 @@ def _render_trajectory_video(
output_filename: Name of the output file.
rendered_output_name: Name of the renderer output to use.
rendered_resolution_scaling_factor: Scaling factor to apply to the camera image resolution.
Defaults to 1.0.
seconds: Number for the output video. Defaults to 5.0.
seconds: Number for the output video.
"""
console.print("[bold green]Creating trajectory video")
images = []
+4 -4
View File
@@ -126,10 +126,10 @@ def launch(
main_func (Callable): function that will be called by the distributed workers
num_gpus_per_machine (int): number of GPUs per machine
num_machines (int, optional): total number of machines
machine_rank (int, optional): rank of this machine. Defaults to 0.
dist_url (str, optional): url to connect to for distributed jobs. Defaults to "auto".
config (Config, optional): config file specifying training regimen. Defaults to None.
timeout (timedelta, optional): timeout of the distributed workers. Defaults to DEFAULT_TIMEOUT.
machine_rank (int, optional): rank of this machine.
dist_url (str, optional): url to connect to for distributed jobs.
config (Config, optional): config file specifying training regimen.
timeout (timedelta, optional): timeout of the distributed workers.
"""
assert config is not None
world_size = num_machines * num_gpus_per_machine