ai2_kit.core package

Submodules

• ai2_kit.core.artifact module
  • Artifact
    • Artifact.attrs
    • Artifact.executor
    • Artifact.format
    • Artifact.includes
    • Artifact.key
    • Artifact.url
    • Artifact.join()
    • Artifact.of()
    • Artifact.to_dict()
  • ArtifactDict
    • ArtifactDict.attrs
    • ArtifactDict.executor
    • ArtifactDict.format
    • ArtifactDict.includes
    • ArtifactDict.key
    • ArtifactDict.url
• ai2_kit.core.checkpoint module
  • CheckpointService
    • CheckpointService.apply_checkpoint()
    • CheckpointService.set_checkpoint_dir()
  • FnInfo
    • FnInfo.args
    • FnInfo.call_site
    • FnInfo.fn_name
    • FnInfo.kwargs
  • apply_checkpoint()
  • set_checkpoint_dir()
• ai2_kit.core.cmd module
  • CmdGroup
• ai2_kit.core.connector module
  • BaseConnector
    • BaseConnector.download()
    • BaseConnector.dump_text()
    • BaseConnector.glob()
    • BaseConnector.run()
    • BaseConnector.sym_link()
    • BaseConnector.upload()
  • LocalConnector
    • LocalConnector.download()
    • LocalConnector.dump_text()
    • LocalConnector.glob()
    • LocalConnector.run()
    • LocalConnector.sym_link()
    • LocalConnector.upload()
  • SshConfig
    • SshConfig.gateway
    • SshConfig.host
  • SshConnector
    • SshConnector.download()
    • SshConnector.dump_text()
    • SshConnector.from_config()
    • SshConnector.get()
    • SshConnector.get_dir()
    • SshConnector.get_sftp()
    • SshConnector.glob()
    • SshConnector.mkdir()
    • SshConnector.put()
    • SshConnector.put_dir()
    • SshConnector.run()
    • SshConnector.sym_link()
    • SshConnector.upload()
  • get_ln_cmd()
  • safe_basename()
• ai2_kit.core.executor module
  • BaseExecutorConfig
    • BaseExecutorConfig.python_cmd
    • BaseExecutorConfig.queue_system
    • BaseExecutorConfig.ssh
    • BaseExecutorConfig.work_dir
  • Executor
    • Executor.download()
    • Executor.dump_text()
    • Executor.glob()
    • Executor.init()
    • Executor.load_text()
    • Executor.mkdir()
    • Executor.name
    • Executor.python_cmd
    • Executor.resolve_artifact()
    • Executor.run()
    • Executor.run_python_fn()
    • Executor.run_python_script()
    • Executor.setup_workspace()
    • Executor.submit()
    • Executor.tmp_dir
    • Executor.upload()
    • Executor.work_dir
  • ExecutorManager
    • ExecutorManager.get_executor()
  • HpcExecutor
    • HpcExecutor.download()
    • HpcExecutor.dump_text()
    • HpcExecutor.from_config()
    • HpcExecutor.glob()
    • HpcExecutor.init()
    • HpcExecutor.is_local
    • HpcExecutor.load_text()
    • HpcExecutor.mkdir()
    • HpcExecutor.resolve_artifact()
    • HpcExecutor.run()
    • HpcExecutor.run_python_fn()
    • HpcExecutor.run_python_script()
    • HpcExecutor.submit()
    • HpcExecutor.upload()
    • HpcExecutor.upload_python_pkg()
  • create_executor()
  • fn_to_script()
  • pickle_converts()
• ai2_kit.core.future module
  • IFuture
    • IFuture.done()
    • IFuture.result()
    • IFuture.result_async()
• ai2_kit.core.job module
  • JobFuture
    • JobFuture.cancel()
    • JobFuture.get_job_state()
    • JobFuture.is_success()
    • JobFuture.resubmit()
  • JobState
    • JobState.CANCELLED
    • JobState.COMPLETED
    • JobState.FAILED
    • JobState.HELD
    • JobState.PENDING
    • JobState.RUNNING
    • JobState.TIMEOUT
    • JobState.UNKNOWN
    • JobState.status_name
    • JobState.terminal
    • JobState.value
  • TimeoutError
  • gather_jobs()
• ai2_kit.core.log module
  • get_logger()
• ai2_kit.core.pydantic module
  • BaseModel
    • BaseModel.Config
      • BaseModel.Config.extra
• ai2_kit.core.queue_system module
  • BaseQueueSystem
    • BaseQueueSystem.cancel()
    • BaseQueueSystem.connector
    • BaseQueueSystem.get_job_id_envvar()
    • BaseQueueSystem.get_job_id_pattern()
    • BaseQueueSystem.get_job_state()
    • BaseQueueSystem.get_polling_interval()
    • BaseQueueSystem.get_script_suffix()
    • BaseQueueSystem.get_setup_script()
    • BaseQueueSystem.get_submit_cmd()
    • BaseQueueSystem.submit()
  • Lsf
    • Lsf.cancel()
    • Lsf.config
    • Lsf.get_job_id_envvar()
    • Lsf.get_job_id_pattern()
    • Lsf.get_job_state()
    • Lsf.get_polling_interval()
    • Lsf.get_script_suffix()
    • Lsf.get_submit_cmd()
  • PBS
    • PBS.cancel()
    • PBS.config
    • PBS.get_job_id_envvar()
    • PBS.get_job_id_pattern()
    • PBS.get_job_state()
    • PBS.get_script_suffix()
    • PBS.get_setup_script()
    • PBS.get_submit_cmd()
    • PBS.translate_table
  • QueueJobFuture
    • QueueJobFuture.cancel()
    • QueueJobFuture.done()
    • QueueJobFuture.get_job_state()
    • QueueJobFuture.is_success()
    • QueueJobFuture.resubmit()
    • QueueJobFuture.result()
    • QueueJobFuture.result_async()
    • QueueJobFuture.success_indicator_path
  • QueueSystemConfig
    • QueueSystemConfig.lsf
    • QueueSystemConfig.pbs
    • QueueSystemConfig.slurm
    • QueueSystemConfig.LSF
      • QueueSystemConfig.LSF.bjobs_bin
      • QueueSystemConfig.LSF.bsub_bin
      • QueueSystemConfig.LSF.polling_interval
    • QueueSystemConfig.PBS
      • QueueSystemConfig.PBS.qdel_bin
      • QueueSystemConfig.PBS.qstat_bin
      • QueueSystemConfig.PBS.qsub_bin
    • QueueSystemConfig.Slurm
      • QueueSystemConfig.Slurm.polling_interval
      • QueueSystemConfig.Slurm.sbatch_bin
      • QueueSystemConfig.Slurm.scancel_bin
      • QueueSystemConfig.Slurm.squeue_bin
  • Slurm
    • Slurm.cancel()
    • Slurm.config
    • Slurm.get_job_id_envvar()
    • Slurm.get_job_id_pattern()
    • Slurm.get_job_state()
    • Slurm.get_polling_interval()
    • Slurm.get_script_suffix()
    • Slurm.get_submit_cmd()
    • Slurm.translate_table
  • inject_cmd_to_script()
• ai2_kit.core.resource_manager module
  • ResourceManager
    • ResourceManager.default_executor
    • ResourceManager.get_artifact()
    • ResourceManager.get_artifacts()
    • ResourceManager.get_executor()
    • ResourceManager.resolve_artifact()
    • ResourceManager.resolve_artifacts()
• ai2_kit.core.script module
  • BashScript
    • BashScript.steps
    • BashScript.template
    • BashScript.render()
  • BashStep
    • BashStep.checkpoint
    • BashStep.cmd
    • BashStep.cwd
    • BashStep.exit_on_error
    • BashStep.render()
  • BashTemplate
    • BashTemplate.header
    • BashTemplate.setup
    • BashTemplate.shebang
    • BashTemplate.teardown
  • eoe_step()
  • exit_on_error_statment()
  • make_gpu_parallel_steps()
• ai2_kit.core.util module
  • JoinTag
    • JoinTag.from_yaml()
    • JoinTag.register()
    • JoinTag.to_yaml()
    • JoinTag.yaml_tag
  • LoadTextTag
    • LoadTextTag.from_yaml()
    • LoadTextTag.register()
    • LoadTextTag.to_yaml()
    • LoadTextTag.yaml_tag
  • LoadYamlTag
    • LoadYamlTag.from_yaml()
    • LoadYamlTag.register()
    • LoadYamlTag.to_yaml()
    • LoadYamlTag.yaml_tag
  • cmd_with_checkpoint()
  • create_fn()
  • dict_nested_get()
  • dict_nested_set()
  • dict_remove_dot_keys()
  • dump_json()
  • dump_text()
  • ensure_dir()
  • expand_globs()
  • flat_evenly()
  • flatten()
  • flush_stdio()
  • format_env_string()
  • get_yaml()
  • limit()
  • list_even_sample()
  • list_random_sample()
  • list_sample()
  • list_split()
  • load_json()
  • load_text()
  • load_yaml_file()
  • load_yaml_files()
  • merge_dict()
  • nested_set()
  • parse_path_list()
  • perf_log()
  • s_uuid()
  • short_hash()
  • slice_from_str()
  • sort_unique_str_list()
  • to_awaitable()
  • wait_for_change()

Module contents