nvflare.job_config.file_source module

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

Bases: object

Constructor of FileSource A FileSource defines additional file(s) to be added to the job app’s app_folder_type folder when generating the 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 app_folder folder that the copied source will be placed.

  • app_folder_type – the type of the app folder to place the copied files. Valid values are: custom, config If not specified, default to “custom”

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: