AGILab Logo

Getting Started

  • Quick-Start
    • Prerequisites
      • LICENSE
      • Install Agilab
      • Cluster installs
      • Next steps
      • Support
  • Introduction
    • Overview
    • Purpose
    • Target Audience
    • Main Dependencies
    • Technologies Selection Criteria
    • Example: Aircraft Radio Communication
  • Features
    • agi-core
    • agilab

Core Topics

  • Cluster
    • Cluster Help
      • Overview
      • Principle
    • Key Generation
      • 1. Generate the keys
      • 2. Loading the private key in SSH Agent
        • 2.1 Load the private key
        • 2.2 Verify the key Addition
      • 3. Copy the public key to the server
        • 3.1 Allow your key
        • 3.2 Verification
        • Bidirectional trust between worker Macs
      • Troubleshooting
        • SSHD Service
      • Useful links
  • Cluster Help
    • Overview
    • Principle
  • AGILab
  • AGILab Architecture
    • Component view
    • Pipeline example
    • AGILAB.py navigation
    • Manager vs worker responsibilities
    • Layers at a glance
    • Runtime flow
    • Repository map
    • Core vs optional apps
    • Documentation map
    • See also
  • Learning Workflows
    • Training vs inference
      • Reinforcement learning (example)
      • Optimization / ILP baseline (example)
    • Continuous learning (optional)
    • Graph neural networks (message passing)
    • Federated learning (optional)
  • AGI Core Architecture
    • Modules at a glance
    • Execution flow
    • Repository pointers
    • Tips for contributions
    • See also
  • AGILab in the MLOps Toolchain
    • Where AGILab helps
    • What AGILab does not aim to cover
    • Positioning vs. other tools
    • Suggested workflow
    • See also
  • Framework API
    • Core packages
      • agi-env API
        • Usage Example
        • Reference
      • agi-node API
        • Path handling
        • Argument helpers
        • Managed PC path remapping
        • Output directory helpers
        • Reference
      • agi-distributor API
        • Usage Example
        • Reference
    • Working with the API
    • App structure conventions
  • Module Reference
    • agi_env package
      • Notes on singleton and pre‑init behavior
      • AgiEnv
        • AgiEnv.EXTRA_INDEX_URL
        • AgiEnv.GUI_SAMPLING
        • AgiEnv.INDEX_URL
        • AgiEnv.TABLE_MAX_ROWS
        • AgiEnv.__init__()
        • AgiEnv.active()
        • AgiEnv.app
        • AgiEnv.apps_path
        • AgiEnv.apps_repository_root
        • AgiEnv.benchmark
        • AgiEnv.change_app()
        • AgiEnv.check_internet()
        • AgiEnv.clone_directory()
        • AgiEnv.clone_project()
        • AgiEnv.copy_existing_projects()
        • AgiEnv.create_junction_windows()
        • AgiEnv.create_rename_map()
        • AgiEnv.create_symlink()
        • AgiEnv.create_symlink_windows()
        • AgiEnv.current()
        • AgiEnv.debug
        • AgiEnv.envars
        • AgiEnv.err_log
        • AgiEnv.extract_base_info()
        • AgiEnv.get_base_classes()
        • AgiEnv.get_base_worker_cls()
        • AgiEnv.get_full_attribute_name()
        • AgiEnv.get_import_mapping()
        • AgiEnv.get_projects()
        • AgiEnv.has_admin_rights()
        • AgiEnv.has_agilab_anywhere_under_home()
        • AgiEnv.humanize_validation_errors()
        • AgiEnv.hw_rapids_capable
        • AgiEnv.init_done
        • AgiEnv.init_envars_app()
        • AgiEnv.install_type
        • AgiEnv.is_local()
        • AgiEnv.is_local_worker
        • AgiEnv.is_source_env
        • AgiEnv.is_valid_ip()
        • AgiEnv.is_worker_env
        • AgiEnv.locate_agi_installation()
        • AgiEnv.locate_agilab_installation()
        • AgiEnv.log_info()
        • AgiEnv.logger
        • AgiEnv.mode2int()
        • AgiEnv.mode2str()
        • AgiEnv.out_log
        • AgiEnv.pyvers_worker
        • AgiEnv.read_agilab_path()
        • AgiEnv.read_gitignore()
        • AgiEnv.replace_content()
        • AgiEnv.reset()
        • AgiEnv.resolve_share_path()
        • AgiEnv.resources_path
        • AgiEnv.run()
        • AgiEnv.run_agi()
        • AgiEnv.run_async()
        • AgiEnv.set_env_var()
        • AgiEnv.share_root_path()
        • AgiEnv.skip_repo_links
        • AgiEnv.snippet_tail
        • AgiEnv.target
        • AgiEnv.unzip_data()
        • AgiEnv.uv
        • AgiEnv.verbose
      • ContentRenamer
        • ContentRenamer.__init__()
        • ContentRenamer.generic_visit()
        • ContentRenamer.visit()
        • ContentRenamer.visit_AnnAssign()
        • ContentRenamer.visit_Assign()
        • ContentRenamer.visit_Attribute()
        • ContentRenamer.visit_ClassDef()
        • ContentRenamer.visit_Constant()
        • ContentRenamer.visit_For()
        • ContentRenamer.visit_FunctionDef()
        • ContentRenamer.visit_Global()
        • ContentRenamer.visit_Import()
        • ContentRenamer.visit_ImportFrom()
        • ContentRenamer.visit_Name()
        • ContentRenamer.visit_arg()
        • ContentRenamer.visit_nonlocal()
      • is_packaging_cmd()
      • normalize_path()
      • parse_level()
      • strip_time_level_prefix()
    • agi_node package
      • DagWorker
        • DagWorker.args_dump_mode
        • DagWorker.args_dumper
        • DagWorker.args_ensure_defaults
        • DagWorker.args_loader
        • DagWorker.args_merger
        • DagWorker.as_dict()
        • DagWorker.break()
        • DagWorker.break_loop()
        • DagWorker.default_settings_path
        • DagWorker.default_settings_section
        • DagWorker.env
        • DagWorker.expand()
        • DagWorker.expand_and_join()
        • DagWorker.from_toml()
        • DagWorker.get_work()
        • DagWorker.loop()
        • DagWorker.managed_pc_home_suffix
        • DagWorker.managed_pc_path_fields
        • DagWorker.normalize_dataset_path()
        • DagWorker.prepare_output_dir()
        • DagWorker.setup_args()
        • DagWorker.setup_data_directories()
        • DagWorker.start()
        • DagWorker.stop()
        • DagWorker.to_toml()
        • DagWorker.verbose
        • DagWorker.works()
      • pandas_worker Framework Callback Functions Module
      • PandasWorker
        • PandasWorker.verbose
        • PandasWorker.data_out
        • PandasWorker.worker_id
        • PandasWorker.args
        • PandasWorker.args_dump_mode
        • PandasWorker.args_dumper
        • PandasWorker.args_ensure_defaults
        • PandasWorker.args_loader
        • PandasWorker.args_merger
        • PandasWorker.as_dict()
        • PandasWorker.break()
        • PandasWorker.break_loop()
        • PandasWorker.default_settings_path
        • PandasWorker.default_settings_section
        • PandasWorker.env
        • PandasWorker.expand()
        • PandasWorker.expand_and_join()
        • PandasWorker.from_toml()
        • PandasWorker.loop()
        • PandasWorker.managed_pc_home_suffix
        • PandasWorker.managed_pc_path_fields
        • PandasWorker.normalize_dataset_path()
        • PandasWorker.prepare_output_dir()
        • PandasWorker.setup_args()
        • PandasWorker.setup_data_directories()
        • PandasWorker.start()
        • PandasWorker.stop()
        • PandasWorker.to_toml()
        • PandasWorker.verbose
        • PandasWorker.work_done()
        • PandasWorker.work_pool()
        • PandasWorker.works()
      • data_worker Framework Callback Functions Module
      • PolarsWorker
        • PolarsWorker.verbose
        • PolarsWorker.data_out
        • PolarsWorker.worker_id
        • PolarsWorker.args
        • PolarsWorker.args_dump_mode
        • PolarsWorker.args_dumper
        • PolarsWorker.args_ensure_defaults
        • PolarsWorker.args_loader
        • PolarsWorker.args_merger
        • PolarsWorker.as_dict()
        • PolarsWorker.break()
        • PolarsWorker.break_loop()
        • PolarsWorker.default_settings_path
        • PolarsWorker.default_settings_section
        • PolarsWorker.env
        • PolarsWorker.expand()
        • PolarsWorker.expand_and_join()
        • PolarsWorker.from_toml()
        • PolarsWorker.loop()
        • PolarsWorker.managed_pc_home_suffix
        • PolarsWorker.managed_pc_path_fields
        • PolarsWorker.normalize_dataset_path()
        • PolarsWorker.prepare_output_dir()
        • PolarsWorker.setup_args()
        • PolarsWorker.setup_data_directories()
        • PolarsWorker.start()
        • PolarsWorker.stop()
        • PolarsWorker.to_toml()
        • PolarsWorker.verbose
        • PolarsWorker.work_done()
        • PolarsWorker.work_pool()
        • PolarsWorker.works()
    • agi_cluster package
      • AGI
        • AGI.CYTHON_MODE
        • AGI.DASK_MODE
        • AGI.PYTHON_MODE
        • AGI.RAPIDS_MODE
        • AGI.__init__()
        • AGI.debug
        • AGI.distribute()
        • AGI.env
        • AGI.exec_ssh()
        • AGI.exec_ssh_async()
        • AGI.find_free_port()
        • AGI.get_default_local_ip()
        • AGI.get_distrib()
        • AGI.get_ssh_connection()
        • AGI.install()
        • AGI.run()
        • AGI.send_file()
        • AGI.send_files()
        • AGI.serve()
        • AGI.update()
        • AGI.verbose
    • agilab package
      • main()
  • Environment Variables
  • FAQ
    • Missing worker packages during AGI.run_*
    • Why installers still build eggs
    • Do we already have DAG/task orchestration?
    • Who manages multithreading when Dask is disabled?
    • Regenerating IDE run configurations
    • “VIRTUAL_ENV … does not match the project environment” warning
    • Why does a run create distribution.json?
    • Switching the active app in Streamlit
    • Docs drift after touching core APIs
    • AGI.install_* fails looking for pyproject.toml
    • Where are installer logs written?
  • Project Files Structure
  • Installation Overview
  • Troubleshooting
    • A - Prerequisite:
    • B - Pycharm Run/Debug configurations:
    • C - Exemple of Tests Sequence:
    • D - agilab_run_dev vs agilab_run_enduser vs lab_run:
    • E - macOS NFS server checklist:
  • Known Bugs
    • <install.sh> do not install your Run/Debug Configurations :
    • <install.sh> freeze:
    • <UV> VIRTUAL_ENV Warning
    • <UV> Sync Failed
    • <DASK> Debug Issue
    • <PYCHARM> Run/Debug Configuration is Broken
    • <PYCHARM> Can’t open your project
    • Failed to read pydantic metadata
  • Licenses
    • Agi-cluster Licenses
    • Agi-node Licenses
    • Agi-env Licenses
    • Agi-core Licenses
    • Mycode-project Licenses
    • Flight-project Licenses

Pages

  • ▶️ EDIT
    • Sidebar
    • Main Content Area
    • Support
  • ▶️ EXECUTE
    • Introduction
    • Sidebar
    • Main Content Area
  • ▶️ EXPERIMENT
    • Sidebar
    • Main Content Area
      • ASSISTANT
      • HISTORY
  • ▶️ EXPLORE
    • Introduction
    • Sidebar
    • Main Content Area
    • Tips & Notes
  • ▶️ AGILAB (Home dashboard)
    • Navigation model
    • Learning lifecycle (when applicable)
    • See also
  • apps bounded pages
    • view_autoencoder_latenspace
    • view_barycentric
    • view_maps
    • view_maps_3d
    • view_maps_network
  • ▶️ APPS PAGES
    • Introduction
    • Built-in vs Plugin Pages
    • Sidebar
    • Main Content Area

Apps Examples

  • MyCode Project
    • Overview
    • Scientific placeholders
    • Manager (mycode.mycode)
    • Args (mycode.app_args)
    • Worker (mycode_worker.mycode_worker)
    • Assets & Tests
    • API Reference
      • Mycode
        • Mycode.__init__()
        • Mycode.args_dump_mode
        • Mycode.args_dumper
        • Mycode.args_ensure_defaults
        • Mycode.args_loader
        • Mycode.args_merger
        • Mycode.as_dict()
        • Mycode.break()
        • Mycode.break_loop()
        • Mycode.build_distribution()
        • Mycode.default_settings_path
        • Mycode.default_settings_section
        • Mycode.env
        • Mycode.expand()
        • Mycode.expand_and_join()
        • Mycode.from_toml()
        • Mycode.loop()
        • Mycode.managed_pc_home_suffix
        • Mycode.managed_pc_path_fields
        • Mycode.normalize_dataset_path()
        • Mycode.pool_init()
        • Mycode.prepare_output_dir()
        • Mycode.setup_args()
        • Mycode.setup_data_directories()
        • Mycode.start()
        • Mycode.stop()
        • Mycode.to_toml()
        • Mycode.verbose
        • Mycode.work_done()
        • Mycode.work_pool()
        • Mycode.worker_vars
      • MycodeApp
        • MycodeApp.__init__()
        • MycodeApp.args_dump_mode
        • MycodeApp.args_dumper
        • MycodeApp.args_ensure_defaults
        • MycodeApp.args_loader
        • MycodeApp.args_merger
        • MycodeApp.as_dict()
        • MycodeApp.break()
        • MycodeApp.break_loop()
        • MycodeApp.build_distribution()
        • MycodeApp.default_settings_path
        • MycodeApp.default_settings_section
        • MycodeApp.env
        • MycodeApp.expand()
        • MycodeApp.expand_and_join()
        • MycodeApp.from_toml()
        • MycodeApp.loop()
        • MycodeApp.managed_pc_home_suffix
        • MycodeApp.managed_pc_path_fields
        • MycodeApp.normalize_dataset_path()
        • MycodeApp.pool_init()
        • MycodeApp.prepare_output_dir()
        • MycodeApp.setup_args()
        • MycodeApp.setup_data_directories()
        • MycodeApp.start()
        • MycodeApp.stop()
        • MycodeApp.to_toml()
        • MycodeApp.verbose
        • MycodeApp.work_done()
        • MycodeApp.work_pool()
        • MycodeApp.worker_vars
      • ArgsModel
      • ArgsOverrides
      • MycodeArgs
        • MycodeArgs.__init__()
        • MycodeArgs.construct()
        • MycodeArgs.copy()
        • MycodeArgs.data_in
        • MycodeArgs.data_out
        • MycodeArgs.dict()
        • MycodeArgs.files
        • MycodeArgs.from_orm()
        • MycodeArgs.json()
        • MycodeArgs.model_computed_fields
        • MycodeArgs.model_config
        • MycodeArgs.model_construct()
        • MycodeArgs.model_copy()
        • MycodeArgs.model_dump()
        • MycodeArgs.model_dump_json()
        • MycodeArgs.model_extra
        • MycodeArgs.model_fields
        • MycodeArgs.model_fields_set
        • MycodeArgs.model_json_schema()
        • MycodeArgs.model_parametrized_name()
        • MycodeArgs.model_post_init()
        • MycodeArgs.model_rebuild()
        • MycodeArgs.model_validate()
        • MycodeArgs.model_validate_json()
        • MycodeArgs.model_validate_strings()
        • MycodeArgs.nfile
        • MycodeArgs.nread
        • MycodeArgs.nskip
        • MycodeArgs.parse_file()
        • MycodeArgs.parse_obj()
        • MycodeArgs.parse_raw()
        • MycodeArgs.reset_target
        • MycodeArgs.schema()
        • MycodeArgs.schema_json()
        • MycodeArgs.update_forward_refs()
        • MycodeArgs.validate()
      • MycodeArgsTD
        • MycodeArgsTD.__init__()
        • MycodeArgsTD.clear()
        • MycodeArgsTD.copy()
        • MycodeArgsTD.data_in
        • MycodeArgsTD.data_out
        • MycodeArgsTD.files
        • MycodeArgsTD.fromkeys()
        • MycodeArgsTD.get()
        • MycodeArgsTD.items()
        • MycodeArgsTD.keys()
        • MycodeArgsTD.nfile
        • MycodeArgsTD.nread
        • MycodeArgsTD.nskip
        • MycodeArgsTD.pop()
        • MycodeArgsTD.popitem()
        • MycodeArgsTD.reset_target
        • MycodeArgsTD.setdefault()
        • MycodeArgsTD.update()
        • MycodeArgsTD.values()
      • dump_args()
      • ensure_defaults()
      • load_args()
      • merge_args()
      • MycodeWorker
        • MycodeWorker.args_dump_mode
        • MycodeWorker.args_dumper
        • MycodeWorker.args_ensure_defaults
        • MycodeWorker.args_loader
        • MycodeWorker.args_merger
        • MycodeWorker.as_dict()
        • MycodeWorker.break()
        • MycodeWorker.break_loop()
        • MycodeWorker.default_settings_path
        • MycodeWorker.default_settings_section
        • MycodeWorker.env
        • MycodeWorker.expand()
        • MycodeWorker.expand_and_join()
        • MycodeWorker.from_toml()
        • MycodeWorker.loop()
        • MycodeWorker.managed_pc_home_suffix
        • MycodeWorker.managed_pc_path_fields
        • MycodeWorker.normalize_dataset_path()
        • MycodeWorker.prepare_output_dir()
        • MycodeWorker.setup_args()
        • MycodeWorker.setup_data_directories()
        • MycodeWorker.start()
        • MycodeWorker.stop()
        • MycodeWorker.to_toml()
        • MycodeWorker.verbose
        • MycodeWorker.work_done()
        • MycodeWorker.work_pool()
        • MycodeWorker.works()
  • Flight Project
    • Overview
    • Scientific highlights
    • Manager (flight.flight)
    • Args (flight.flight_args)
    • Worker (flight_worker.flight_worker)
    • Assets & Tests
    • API Reference
      • Flight
        • Flight.__init__()
        • Flight.args_dump_mode
        • Flight.args_dumper
        • Flight.args_ensure_defaults
        • Flight.args_loader
        • Flight.args_merger
        • Flight.as_dict()
        • Flight.break()
        • Flight.break_loop()
        • Flight.build_distribution()
        • Flight.default_settings_path
        • Flight.default_settings_section
        • Flight.env
        • Flight.expand()
        • Flight.expand_and_join()
        • Flight.extract_plane_from_file_name()
        • Flight.from_toml()
        • Flight.get_data_from_files()
        • Flight.get_data_from_hawk()
        • Flight.get_partition_by_planes()
        • Flight.ivq_logs
        • Flight.loop()
        • Flight.managed_pc_home_suffix
        • Flight.managed_pc_path_fields
        • Flight.normalize_dataset_path()
        • Flight.prepare_output_dir()
        • Flight.setup_args()
        • Flight.setup_data_directories()
        • Flight.start()
        • Flight.stop()
        • Flight.to_toml()
        • Flight.verbose
      • FlightApp
        • FlightApp.__init__()
        • FlightApp.args_dump_mode
        • FlightApp.args_dumper
        • FlightApp.args_ensure_defaults
        • FlightApp.args_loader
        • FlightApp.args_merger
        • FlightApp.as_dict()
        • FlightApp.break()
        • FlightApp.break_loop()
        • FlightApp.build_distribution()
        • FlightApp.default_settings_path
        • FlightApp.default_settings_section
        • FlightApp.env
        • FlightApp.expand()
        • FlightApp.expand_and_join()
        • FlightApp.extract_plane_from_file_name()
        • FlightApp.from_toml()
        • FlightApp.get_data_from_files()
        • FlightApp.get_data_from_hawk()
        • FlightApp.get_partition_by_planes()
        • FlightApp.ivq_logs
        • FlightApp.loop()
        • FlightApp.managed_pc_home_suffix
        • FlightApp.managed_pc_path_fields
        • FlightApp.normalize_dataset_path()
        • FlightApp.prepare_output_dir()
        • FlightApp.setup_args()
        • FlightApp.setup_data_directories()
        • FlightApp.start()
        • FlightApp.stop()
        • FlightApp.to_toml()
        • FlightApp.verbose
      • ArgsModel
      • ArgsOverrides
      • FlightArgs
        • FlightArgs.__init__()
        • FlightArgs.construct()
        • FlightArgs.copy()
        • FlightArgs.data_in
        • FlightArgs.data_out
        • FlightArgs.data_source
        • FlightArgs.datemax
        • FlightArgs.datemin
        • FlightArgs.dict()
        • FlightArgs.files
        • FlightArgs.from_orm()
        • FlightArgs.json()
        • FlightArgs.model_computed_fields
        • FlightArgs.model_config
        • FlightArgs.model_construct()
        • FlightArgs.model_copy()
        • FlightArgs.model_dump()
        • FlightArgs.model_dump_json()
        • FlightArgs.model_extra
        • FlightArgs.model_fields
        • FlightArgs.model_fields_set
        • FlightArgs.model_json_schema()
        • FlightArgs.model_parametrized_name()
        • FlightArgs.model_post_init()
        • FlightArgs.model_rebuild()
        • FlightArgs.model_validate()
        • FlightArgs.model_validate_json()
        • FlightArgs.model_validate_strings()
        • FlightArgs.nfile
        • FlightArgs.nread
        • FlightArgs.nskip
        • FlightArgs.output_format
        • FlightArgs.parse_file()
        • FlightArgs.parse_obj()
        • FlightArgs.parse_raw()
        • FlightArgs.reset_target
        • FlightArgs.sampling_rate
        • FlightArgs.schema()
        • FlightArgs.schema_json()
        • FlightArgs.to_toml_payload()
        • FlightArgs.update_forward_refs()
        • FlightArgs.validate()
      • FlightArgsTD
        • FlightArgsTD.__init__()
        • FlightArgsTD.clear()
        • FlightArgsTD.copy()
        • FlightArgsTD.data_in
        • FlightArgsTD.data_out
        • FlightArgsTD.data_source
        • FlightArgsTD.datemax
        • FlightArgsTD.datemin
        • FlightArgsTD.files
        • FlightArgsTD.fromkeys()
        • FlightArgsTD.get()
        • FlightArgsTD.items()
        • FlightArgsTD.keys()
        • FlightArgsTD.nfile
        • FlightArgsTD.nread
        • FlightArgsTD.nskip
        • FlightArgsTD.output_format
        • FlightArgsTD.pop()
        • FlightArgsTD.popitem()
        • FlightArgsTD.reset_target
        • FlightArgsTD.sampling_rate
        • FlightArgsTD.setdefault()
        • FlightArgsTD.update()
        • FlightArgsTD.values()
      • apply_source_defaults()
      • dump_args()
      • dump_args_to_toml()
      • ensure_defaults()
      • load_args()
      • load_args_from_toml()
      • merge_args()
      • FlightWorker
        • FlightWorker.args_dump_mode
        • FlightWorker.args_dumper
        • FlightWorker.args_ensure_defaults
        • FlightWorker.args_loader
        • FlightWorker.args_merger
        • FlightWorker.as_dict()
        • FlightWorker.break()
        • FlightWorker.break_loop()
        • FlightWorker.calculate_speed()
        • FlightWorker.default_settings_path
        • FlightWorker.default_settings_section
        • FlightWorker.env
        • FlightWorker.expand()
        • FlightWorker.expand_and_join()
        • FlightWorker.from_toml()
        • FlightWorker.loop()
        • FlightWorker.managed_pc_home_suffix
        • FlightWorker.managed_pc_path_fields
        • FlightWorker.normalize_dataset_path()
        • FlightWorker.pool_init()
        • FlightWorker.pool_vars
        • FlightWorker.prepare_output_dir()
        • FlightWorker.preprocess_df()
        • FlightWorker.setup_args()
        • FlightWorker.setup_data_directories()
        • FlightWorker.start()
        • FlightWorker.stop()
        • FlightWorker.to_toml()
        • FlightWorker.verbose
        • FlightWorker.work_done()
        • FlightWorker.work_init()
        • FlightWorker.work_pool()
        • FlightWorker.works()

Hosting Sites

  • Agilab project
  • Agilab components
AGILab
  • Agilab project
  • View page source

Agilab project

  • Agilab on Github

Agilab components

  • Agi-env on pypi.org

  • Agi-cluster on pypi.org

  • Agi-node on pypi.org

  • Agilab on pypi.org

Previous

© Copyright 2025, THALES SIX GTS France SAS.

Built with Sphinx using a theme provided by Read the Docs.