Substra Logo
0.25.0

Substrafl documentation

  • Overview
  • SubstraFL examples
  • API reference

Substra documentation

  • User guide
  • Substra examples
  • API reference
    • CLI Reference
      • Summary
      • Commands
    • SDK Reference
      • Client
      • retry_on_exception
      • Models
        • Summary
        • Models
      • Schemas
        • Summary
        • Schemas

Contributing to Substra

  • Contributing Guide
  • Code of Conduct
  • Components
  • Local deployment

Deploying Substra

  • Overview
  • How-To
  • Upgrade notes

Additional Information

  • Community
  • Release notes
  • FAQ
  • Glossary
Substra

API reference¶

substra version: 0.42.0

CLI Reference¶

  • Summary
  • Commands
    • substra config
    • substra login
    • substra organization info
    • substra cancel compute_plan

SDK Reference¶

  • Client
    • backend_mode
    • temp_directory
    • add_algo
    • add_compute_plan
    • add_compute_plan_tasks
    • add_data_sample
    • add_data_samples
    • add_dataset
    • add_task
    • cancel_compute_plan
    • describe_algo
    • describe_dataset
    • download_algo
    • download_dataset
    • download_logs
    • download_model
    • download_model_from_task
    • from_config_file
    • get_algo
    • get_compute_plan
    • get_data_sample
    • get_dataset
    • get_logs
    • get_model
    • get_performances
    • get_task
    • link_dataset_with_data_samples
    • list_algo
    • list_compute_plan
    • list_data_sample
    • list_dataset
    • list_model
    • list_organization
    • list_task
    • login
    • organization_info
    • update_algo
    • update_compute_plan
    • update_dataset
  • retry_on_exception

Models¶

Models describe the objects returned by the platform.

  • Summary
  • Models
    • DataSample
    • Dataset
    • Task
    • Algo
    • ComputePlan
    • Performances
    • Organization
    • Permissions
    • InModel
    • OutModel
    • _File

Schemas¶

Specs are the specifications to register the assets on the platform.

  • Summary
  • Schemas
    • DataSampleSpec
    • DatasetSpec
    • UpdateDatasetSpec
    • AlgoSpec
    • AlgoInputSpec
    • AlgoOutputSpec
    • TaskSpec
    • UpdateAlgoSpec
    • ComputePlanSpec
    • UpdateComputePlanSpec
    • UpdateComputePlanTasksSpec
    • ComputePlanTaskSpec
    • Permissions
    • PrivatePermissions
Next Previous

© Copyright 2023, OWKIN. Revision d0ad9139.

Read the Docs v: 0.25.0
Versions
latest
stable
0.25.0
0.24.0
0.23.1
0.23.0
0.23.0-rc0
0.22.0
0.22.0-rc8
0.22.0-rc7
0.22.0-rc6
0.22.0-rc5
0.22.0-rc4
0.22.0-rc3
0.22.0-rc2
0.22.0-rc1
0.21.0
hosted_notebook
Downloads
On Read the Docs
Project Home
Builds