Substra Logo
1.0.0-1-g7e2366a

What is Substra

  • SubstraFL Overview
  • Substra overview
  • Components
  • Our privacy strategy

Tutorials

  • SubstraFL examples
  • Substra examples

Reference guides

  • SubstraFL API reference
  • Substra API reference
    • SDK Reference
      • Client
      • retry_on_exception
      • Models
        • Summary
        • Models
      • Schemas
        • Summary
        • Schemas
  • Kubernetes deployment reference

How-to guides

  • How-to guides for using Substra
  • How-to guides for deploying Substra
  • How-to guides for developing Substra

Contributing guide

  • Contributing Guide
  • Code of Conduct

Additional Information

  • Community
  • Release notes
  • FAQ
  • Glossary
Substra

Substra API reference

substra version: 1.0.0

SDK Reference

  • Client
    • backend_mode
    • temp_directory
    • add_compute_plan
    • add_compute_plan_tasks
    • add_data_sample
    • add_data_samples
    • add_dataset
    • add_function
    • add_task
    • cancel_compute_plan
    • describe_dataset
    • describe_function
    • download_dataset
    • download_function
    • download_logs
    • download_model
    • download_model_from_task
    • get_compute_plan
    • get_data_sample
    • get_dataset
    • get_function
    • get_logs
    • get_model
    • get_performances
    • get_task
    • get_task_output_asset
    • link_dataset_with_data_samples
    • list_compute_plan
    • list_data_sample
    • list_dataset
    • list_function
    • list_model
    • list_organization
    • list_task
    • list_task_input_assets
    • list_task_output_assets
    • login
    • logout
    • organization_info
    • update_compute_plan
    • update_dataset
    • update_function
    • wait_compute_plan
    • wait_function
    • wait_task
  • retry_on_exception

Models

Models describe the objects returned by the platform.

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

Schemas

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

  • Summary
  • Schemas
    • DataSampleSpec
    • DatasetSpec
    • UpdateDatasetSpec
    • FunctionSpec
    • FunctionInputSpec
    • FunctionOutputSpec
    • TaskSpec
    • ComputeTaskOutputSpec
    • UpdateFunctionSpec
    • ComputePlanSpec
    • UpdateComputePlanSpec
    • UpdateComputePlanTasksSpec
    • ComputePlanTaskSpec
    • Permissions
    • PrivatePermissions
Previous Next

© Copyright 2025, OWKIN.