nvflare.job_config.file_source module

class FileSource(src_path: str, dest_dir=None)[source]

Bases: object

Constructor of FileSource A FileSource defines additional file(s) to be added to the job app’s “custom” folder when generating job config.

Parameters:

  • src_path – the path to the source, which could be a single file or a directory.

  • dest_dir – the relative dir within the “custom” folder that the copied source will be placed.

Note: a FileSource could be any type of files, not limited to “py” files! Even if the source is a python script, no special processing (e.g. package import scanning) will be done.

add_to_fed_job(job, ctx, **kwargs)[source]

This method is used by Job API.

Parameters:

  • job – the Job object to add to

  • ctx – Job Context

Returns: