TorchFort API

The following sections describe the types and functions available in the TorchFort library for C/C++ and Fortran programs and the also the configuration file structure and available options.

• TorchFort Configuration Files
  • Common
    • General Properties
    • Optimizer Properties
    • Learning Rate Schedule Properties
  • Supervised Learning
    • Model Properties
    • Loss Properties
  • Reinforcement Learning
    • Reinforcement Learning Training Algorithm Properties
    • Replay Buffer Properties
    • Action Properties
    • Policy and Critic Properties
    • Learning Rate Schedule Properties
• TorchFort C API
  • General
    • Types
      • torchfort_datatype_t
        • torchfort_datatype_t
          • TORCHFORT_FLOAT
          • TORCHFORT_DOUBLE
          • TORCHFORT_INT32
          • TORCHFORT_INT64
      • torchfort_result_t
        • torchfort_result_t
          • TORCHFORT_RESULT_SUCCESS
          • TORCHFORT_RESULT_INVALID_USAGE
          • TORCHFORT_RESULT_NOT_SUPPORTED
          • TORCHFORT_RESULT_INTERNAL_ERROR
          • TORCHFORT_RESULT_CUDA_ERROR
          • TORCHFORT_RESULT_MPI_ERROR
          • TORCHFORT_RESULT_NCCL_ERROR
      • torchfort_tensor_list_t
        • torchfort_tensor_list_t
    • Global Context Settings
      • torchfort_set_cudnn_benchmark
        • torchfort_set_cudnn_benchmark()
    • Tensor List Management
      • torchfort_tensor_list_create
        • torchfort_tensor_list_create()
      • torchfort_tensor_list_destroy
        • torchfort_tensor_list_destroy()
      • torchfort_tensor_list_add_tensor
        • torchfort_tensor_list_add_tensor()
  • Supervised Learning
    • Model Creation
      • torchfort_create_model
        • torchfort_create_model()
      • torchfort_create_distributed_model
        • torchfort_create_distributed_model()
    • Model Training/Inference
      • torchfort_train
        • torchfort_train()
      • torchfort_train_multiarg
        • torchfort_train_multiarg()
      • torchfort_inference
        • torchfort_inference()
      • torchfort_inference_multiarg
        • torchfort_inference_multiarg()
    • Model Management
      • torchfort_save_model
        • torchfort_save_model()
      • torchfort_load_model
        • torchfort_load_model()
      • torchfort_save_checkpoint
        • torchfort_save_checkpoint()
      • torchfort_load_checkpoint
        • torchfort_load_checkpoint()
    • Weights and Biases Logging
      • torchfort_wandb_log_int
        • torchfort_wandb_log_int()
      • torchfort_wandb_log_float
        • torchfort_wandb_log_float()
      • torchfort_wandb_log_double
        • torchfort_wandb_log_double()
  • Reinforcement Learning
    • Off-Policy Algorithms
      • System Creation
        • torchfort_rl_off_policy_create_system
          • torchfort_rl_off_policy_create_system()
        • torchfort_rl_off_policy_create_distributed_system
          • torchfort_rl_off_policy_create_distributed_system()
      • Training/Evaluation
        • torchfort_rl_off_policy_train_step
          • torchfort_rl_off_policy_train_step()
        • torchfort_rl_off_policy_predict_explore
          • torchfort_rl_off_policy_predict_explore()
        • torchfort_rl_off_policy_predict
          • torchfort_rl_off_policy_predict()
        • torchfort_rl_off_policy_evaluate
          • torchfort_rl_off_policy_evaluate()
      • System Management
        • torchfort_rl_off_policy_update_replay_buffer
          • torchfort_rl_off_policy_update_replay_buffer()
        • torchfort_rl_off_policy_update_replay_buffer_multi
          • torchfort_rl_off_policy_update_replay_buffer_multi()
        • torchfort_rl_off_policy_is_ready
          • torchfort_rl_off_policy_is_ready()
        • torchfort_rl_off_policy_save_checkpoint
          • torchfort_rl_off_policy_save_checkpoint()
        • torchfort_rl_off_policy_load_checkpoint
          • torchfort_rl_off_policy_load_checkpoint()
      • Weights and Biases Logging
        • torchfort_rl_off_policy_wandb_log_int
          • torchfort_rl_off_policy_wandb_log_int()
        • torchfort_rl_off_policy_wandb_log_float
          • torchfort_rl_off_policy_wandb_log_float()
        • torchfort_rl_off_policy_wandb_log_double
          • torchfort_rl_off_policy_wandb_log_double()
    • On-Policy Algorithms
      • System Creation
        • torchfort_rl_on_policy_create_system
          • torchfort_rl_on_policy_create_system()
        • torchfort_rl_on_policy_create_distributed_system
          • torchfort_rl_on_policy_create_distributed_system()
      • Training/Evaluation
        • torchfort_rl_on_policy_train_step
          • torchfort_rl_on_policy_train_step()
        • torchfort_rl_on_policy_predict_explore
          • torchfort_rl_on_policy_predict_explore()
        • torchfort_rl_on_policy_predict
          • torchfort_rl_on_policy_predict()
        • torchfort_rl_on_policy_evaluate
          • torchfort_rl_on_policy_evaluate()
      • System Management
        • torchfort_rl_on_policy_update_rollout_buffer
          • torchfort_rl_on_policy_update_rollout_buffer()
        • torchfort_rl_on_policy_update_rollout_buffer_multi
          • torchfort_rl_on_policy_update_rollout_buffer_multi()
        • torchfort_rl_on_policy_is_ready
          • torchfort_rl_on_policy_is_ready()
        • torchfort_rl_on_policy_save_checkpoint
          • torchfort_rl_on_policy_save_checkpoint()
        • torchfort_rl_on_policy_load_checkpoint
          • torchfort_rl_on_policy_load_checkpoint()
      • Weights and Biases Logging
        • torchfort_rl_on_policy_wandb_log_int
          • torchfort_rl_on_policy_wandb_log_int()
        • torchfort_rl_on_policy_wandb_log_float
          • torchfort_rl_on_policy_wandb_log_float()
        • torchfort_rl_on_policy_wandb_log_double
          • torchfort_rl_on_policy_wandb_log_double()
• TorchFort Fortran API
  • General
    • Types
      • torchfort_datatype
      • torchfort_result
      • torchfort_tensor_list
    • Global Context Settings
      • torchfort_set_cudnn_benchmark
    • Tensor List Management
      • torchfort_tensor_list_create
      • torchfort_tensor_list_destroy
      • torchfort_tensor_list_add_tensor
  • Supervised Learning
    • Model Creation
      • torchfort_create_model
      • torchfort_create_distributed_model
    • Model Training/Inference
      • torchfort_train
      • torchfort_train_multiarg
      • torchfort_inference
      • torchfort_inference_multiarg
    • Model Management
      • torchfort_save_model
      • torchfort_load_model
      • torchfort_save_checkpoint
      • torchfort_load_checkpoint
    • Weights and Biases Logging
      • torchfort_wandb_log_int
      • torchfort_wandb_log_float
      • torchfort_wandb_log_double
  • Reinforcement Learning
    • Off-Policy Algorithms
      • System Creation
        • torchfort_rl_off_policy_create_system
        • torchfort_rl_off_policy_create_distributed_system
      • Training/Evaluation
        • torchfort_rl_off_policy_train_step
        • torchfort_rl_off_policy_predict_explore
        • torchfort_rl_off_policy_predict
        • torchfort_rl_off_policy_evaluate
      • System Management
        • torchfort_rl_off_policy_update_replay_buffer
        • torchfort_rl_off_policy_is_ready
        • torchfort_rl_off_policy_save_checkpoint
        • torchfort_rl_off_policy_load_checkpoint
      • Weights and Biases Logging
        • torchfort_rl_off_policy_wandb_log_int
        • torchfort_rl_off_policy_wandb_log_float
        • torchfort_rl_off_policy_wandb_log_double
    • On-Policy Algorithms
      • System Creation
        • torchfort_rl_on_policy_create_system
        • torchfort_rl_on_policy_create_distributed_system
      • Training/Evaluation
        • torchfort_rl_on_policy_train_step
        • torchfort_rl_on_policy_predict_explore
        • torchfort_rl_on_policy_predict
        • torchfort_rl_on_policy_evaluate
      • System Management
        • torchfort_rl_on_policy_update_rollout_buffer
        • torchfort_rl_on_policy_reset_rollout_buffer
        • torchfort_rl_on_policy_is_ready
        • torchfort_rl_on_policy_save_checkpoint
        • torchfort_rl_on_policy_load_checkpoint
      • Weights and Biases Logging
        • torchfort_rl_on_policy_wandb_log_int
        • torchfort_rl_on_policy_wandb_log_float
        • torchfort_rl_on_policy_wandb_log_double