ait_sdk.develop package

Submodules

ait_sdk.develop.ait_base module

class ait_sdk.develop.ait_base.AITBase

Bases: object

clean_up() → None

最終処理を実装する。 ログファイルのコピー処理などの後始末をするため、logデコレーションしない。

execute(argv: List[str], entry_point_dir: str) → None
main_process() → None
post_process() → None
pre_process() → None

ait_sdk.develop.ait_path_helper module

class ait_sdk.develop.ait_path_helper.AITPathHelper(argv: List[str], ait_input: AITInput, ait_manifest: AITManifest, entry_point_dir: str)

Bases: object

aitのパス補助クラスです。

class for ait path help.

get_input_file_path() → str

input_file_pathを取得します。

Get input_file_path.

Returns:

input_file_path

get_manifest_file_path() → str

manifest_file_pathを取得します。

Get manifest_file_path.

Returns:

manifest_file_path

get_output_download_path(item_name: str) → str

output_download_pathを取得します。

Get output_download_path.

Parameters:

item_name (str) –

項目名を指定します。

Specify the name of the item.

Returns:

output_download_path

get_output_file_path() → str

output_file_pathを取得します。

Get output_file_path.

Returns:

output_file_path

get_output_resource_path(item_name: str) → str

output_resource_pathを取得します。

Get output_resource_path.

Parameters:

item_name (str) –

項目名を指定します。

Specify the name of the item.

Returns:

output_resource_path

ait_sdk.develop.annotation module

ait_sdk.develop.annotation.ait_main(ait_output: AITOutput, path_helper: AITPathHelper, is_ait_launch: bool = True)

mainラッパー関数 main関数の実行時間計測、およびait_outputの出力を実施する。

main wrapper function Measure the execution time of the main function and output the ait_output.

Parameters:

  • ait_output (ait_sdl.common.files.ait_output.AITOutput) –

  • path_helper (ait_sdl.develop.ait_path_helper.AITPathHelper) –

  • is_ait_launch (True for AIT startup, false for jupyter startup) –

Returns:

_decoratorの返り値

Return value of _decorator

ait_sdk.develop.annotation.downloads(ait_output: AITOutput, path_helper: AITPathHelper, item_name: str, file_name: str | None = None)

downloadを追加するためのラッパー関数

デコレータで読み込んだfile_pathを設定するため、関数の引数にはかならずfile_pathを定義すること。 ひとつのdownloadに複数ファイルを設定する場合は、list型かtuple型でパスを返却すること。

Wrapper function for adding the download

To set the file_path loaded by the decorator, the function must define the file_path as an argument. If you set multiple files in one download, you must return the path as a list type or a tuple type.

Parameters:

  • ait_output (ait_sdl.common.files.ait_output.AITOutput) –

  • path_helper (ait_sdl.develop.ait_path_helper.AITPathHelper) –

  • item_name (str) –

  • file_name (str) –

Returns:

_decoratorの返り値

Return value of _decorator

ait_sdk.develop.annotation.measures(ait_output: AITOutput, *names: str, is_many: bool = False)

measureを追加するためのラッパー関数

A wrapper function for adding measure

Parameters:

  • ait_output (ait_sdl.common.files.ait_output.AITOutput) –

  • names (str) –

  • is_many (bool) –

Returns:

_decoratorの返り値

Return value of _decorator

ait_sdk.develop.annotation.resources(ait_output: AITOutput, path_helper: AITPathHelper, item_name: str, file_name: str | None = None)

resourceを追加するためのラッパー関数

デコレータで読み込んだfile_pathを設定するため、関数の引数にはかならずfile_pathを定義すること。 ひとつのresourceに複数ファイルを設定する場合は、list型かtuple型でパスを返却すること。 ファイルパスを返却した場合、そのファイルパスに上書きしてait.output.jsonへ出力する。

Wrapper function for adding resources

In order to set the file_path read by the decorator, the function must always define the file_path as an argument. When multiple files are set in one resource, the path must be returned as a list type or a tuple type. If the file path is returned, it will overwrite the file path and output it to ait.output.json.

Parameters:

  • ait_output (ait_sdl.common.files.ait_output.AITOutput) –

  • path_helper (ait_sdl.develop.ait_path_helper.AITPathHelper) –

  • item_name (str) –

  • file_name (str) –

Returns:

_decoratorの返り値

Return value of _decorator

Module contents