make docstrings consistent

Author: tuulos

metaflow/plugins/aws/batch/batch_decorator.py

@@ -71,19 +71,19 @@ class BatchDecorator(StepDecorator):
         A swappiness value of 0 causes swapping not to happen unless absolutely
         necessary. A swappiness value of 100 causes pages to be swapped very
         aggressively. Accepted values are whole numbers between 0 and 100.
-    use_tmpfs: bool, default False
+    use_tmpfs : bool, default False
         This enables an explicit tmpfs mount for this step.
-    tmpfs_tempdir: bool, default True
+    tmpfs_tempdir : bool, default True
         sets METAFLOW_TEMPDIR to tmpfs_path if set for this step.
-    tmpfs_size: int, optional, default None
+    tmpfs_size : int, optional, default None
         The value for the size (in MiB) of the tmpfs mount for this step.
         This parameter maps to the `--tmpfs` option in Docker. Defaults to 50% of the
         memory allocated for this step.
-    tmpfs_path: str, optional, default None
+    tmpfs_path : str, optional, default None
         Path to tmpfs mount for this step. Defaults to /metaflow_temp.
     inferentia : int, default 0
         Number of Inferentia chips required for this step.
-    efa: int, default: 0
+    efa : int, default 0
         Number of elastic fabric adapter network devices to attach to container
     """
 

metaflow/plugins/aws/step_functions/schedule_decorator.py

@@ -9,16 +9,16 @@ class ScheduleDecorator(FlowDecorator):
 
     Parameters
     ----------
-    hourly : bool, default: False
+    hourly : bool, default False
         Run the workflow hourly.
-    daily : bool, default: True
+    daily : bool, default True
         Run the workflow daily.
-    weekly : bool, default: False
+    weekly : bool, default False
         Run the workflow weekly.
-    cron : str, optional, default: None
+    cron : str, optional, default None
         Run the workflow at [a custom Cron schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions)
         specified by this expression.
-    timezone : str, optional, default: None
+    timezone : str, optional, default None
         Timezone on which the schedule runs (default: None). Currently supported only for Argo workflows,
         which accepts timezones in [IANA format](https://nodatime.org/TimeZones).
     """

metaflow/plugins/events_decorator.py

@@ -43,11 +43,11 @@ class TriggerDecorator(FlowDecorator):
 
     Parameters
     ----------
-    event : Union[str, Dict[str, Any]], default: None
+    event : Union[str, Dict[str, Any]], default None
         Event dependency for this flow.
-    events : List[Union[str, Dict[str, Any]]], default: []
+    events : List[Union[str, Dict[str, Any]]], default []
         Events dependency for this flow.
-    options : Dict[str, Any], default: {}
+    options : Dict[str, Any], default {}
         Backend-specific configuration for tuning eventing behavior.
 
     MF Add To Current
@@ -227,11 +227,11 @@ class TriggerOnFinishDecorator(FlowDecorator):
 
     Parameters
     ----------
-    flow : Union[str, Dict[str, str]], optional, default: None
+    flow : Union[str, Dict[str, str]], optional, default None
         Upstream flow dependency for this flow.
-    flows : List[Union[str, Dict[str, str]]], default: []
+    flows : List[Union[str, Dict[str, str]]], default []
         Upstream flow dependencies for this flow.
-    options : Dict[str, Any], default: {}
+    options : Dict[str, Any], default {}
         Backend-specific configuration for tuning eventing behavior.
 
     MF Add To Current

metaflow/plugins/kubernetes/kubernetes_decorator.py

@@ -41,49 +41,49 @@ class KubernetesDecorator(StepDecorator):
 
     Parameters
     ----------
-    cpu : int, default: 1
+    cpu : int, default 1
         Number of CPUs required for this step. If `@resources` is
         also present, the maximum value from all decorators is used.
-    memory : int, default: 4096
+    memory : int, default 4096
         Memory size (in MB) required for this step. If
         `@resources` is also present, the maximum value from all decorators is
         used.
-    disk : int, default: 10240
+    disk : int, default 10240
         Disk size (in MB) required for this step. If
         `@resources` is also present, the maximum value from all decorators is
         used.
-    image : str, optional, default: None
+    image : str, optional, default None
         Docker image to use when launching on Kubernetes. If not specified, and
         METAFLOW_KUBERNETES_CONTAINER_IMAGE is specified, that image is used. If
         not, a default Docker image mapping to the current version of Python is used.
-    image_pull_policy: str, default: KUBERNETES_IMAGE_PULL_POLICY
+    image_pull_policy: str, default KUBERNETES_IMAGE_PULL_POLICY
         If given, the imagePullPolicy to be applied to the Docker image of the step.
-    service_account : str, default: METAFLOW_KUBERNETES_SERVICE_ACCOUNT
+    service_account : str, default METAFLOW_KUBERNETES_SERVICE_ACCOUNT
         Kubernetes service account to use when launching pod in Kubernetes.
     secrets : List[str], optional, default None
         Kubernetes secrets to use when launching pod in Kubernetes. These
         secrets are in addition to the ones defined in `METAFLOW_KUBERNETES_SECRETS`
         in Metaflow configuration.
-    namespace : str, default: METAFLOW_KUBERNETES_NAMESPACE
+    namespace : str, default METAFLOW_KUBERNETES_NAMESPACE
         Kubernetes namespace to use when launching pod in Kubernetes.
-    gpu: int, optional
+    gpu : int, optional
         Number of GPUs required for this step. A value of zero implies that
         the scheduled node should not have GPUs.
-    gpu_vendor: str, default: KUBERNETES_GPU_VENDOR
+    gpu_vendor : str, default KUBERNETES_GPU_VENDOR
         The vendor of the GPUs to be used for this step.
-    tolerations : List[str], default: METAFLOW_KUBERNETES_TOLERATIONS
+    tolerations : List[str], default METAFLOW_KUBERNETES_TOLERATIONS
         Kubernetes tolerations to use when launching pod in Kubernetes.
-    use_tmpfs: bool, default: False
+    use_tmpfs : bool, default False
         This enables an explicit tmpfs mount for this step.
-    tmpfs_tempdir: bool, default: True
+    tmpfs_tempdir : bool, default True
         sets METAFLOW_TEMPDIR to tmpfs_path if set for this step.
-    tmpfs_size: int, optional, default: None
+    tmpfs_size : int, optional, default: None
         The value for the size (in MiB) of the tmpfs mount for this step.
         This parameter maps to the `--tmpfs` option in Docker. Defaults to 50% of the
         memory allocated for this step.
-    tmpfs_path: str, optional, default: /metaflow_temp
+    tmpfs_path : str, optional, default /metaflow_temp
         Path to tmpfs mount for this step.
-    persistent_volume_claims: Dict[str, str], optional, default: None
+    persistent_volume_claims : Dict[str, str], optional, default None
         A map (dictionary) of persistent volumes to be mounted to the pod for this step. The map is from persistent
         volumes to the path to which the volume is to be mounted, e.g., `{'pvc-name': '/path/to/mount/on'}`.
     """

metaflow/plugins/pypi/conda_decorator.py

@@ -24,15 +24,15 @@ class CondaStepDecorator(StepDecorator):
 
     Parameters
     ----------
-    packages : Dict[str, str], default: {}
+    packages : Dict[str, str], default {}
         Packages to use for this step. The key is the name of the package
         and the value is the version to use.
-    libraries : Dict[str, str], default: {}
+    libraries : Dict[str, str], default {}
         Supported for backward compatibility. When used with packages, packages will take precedence.
     python : str, optional
         Version of Python to use, e.g. '3.7.4'. A default value of None implies
         that the version used will correspond to the version of the Python interpreter used to start the run.
-    disabled : bool, default: False
+    disabled : bool, default False
         If set to True, disables @conda.
     """
 
@@ -276,15 +276,15 @@ class CondaFlowDecorator(FlowDecorator):
 
     Parameters
     ----------
-    packages : Dict[str, str], default: {}
+    packages : Dict[str, str], default {}
         Packages to use for this flow. The key is the name of the package
         and the value is the version to use.
-    libraries : Dict[str, str], default: {}
+    libraries : Dict[str, str], default {}
         Supported for backward compatibility. When used with packages, packages will take precedence.
     python : str, optional
         Version of Python to use, e.g. '3.7.4'. A default value of None implies
         that the version used will correspond to the version of the Python interpreter used to start the run.
-    disabled : bool, default: False
+    disabled : bool, default False
         If set to True, disables Conda.
     """