Function write_signal_file

composer/utils/dist.py:647–666

Writes a signal file to the specified directory. This function creates a signal file in the specified directory. If the directory does Note: Only local rank zero writes the signal file. All other ranks are expected to wait for the signal file. Args: signal_file_name (str): The

(signal_file_name: str, dir_path: Optional[str] = None)

def write_signal_file(signal_file_name: str, dir_path: Optional[str] = None) -> str:
    """Writes a signal file to the specified directory.

    This function creates a signal file in the specified directory. If the directory does
    Note: Only local rank zero writes the signal file. All other ranks are expected to wait for the signal file.

    Args:
        signal_file_name (str): The name of the signal file.
        dir_path (str, optional): The full path to the directory in which to create the signal file. If ``None``,
            the current working directory will be used.
    """
    if dir_path is not None:
        os.makedirs(dir_path, exist_ok=True)

    signal_file_path = os.path.join(dir_path or os.getcwd(), signal_file_name)
    if get_local_rank() == 0:
        with open(signal_file_path, 'w') as _f:
            _f.write('local rank zero done')

    return signal_file_path


@contextmanager