Generic WorkflowΒΆ

Below is a generic flow for using C++ API of oneCCL:

  1. Initialize the library:

    ccl::environment::instance();
    

    Alternatively, you can create communicator objects:

    ccl::communicator_t comm = ccl::environment::instance().create_communicator();
    
  2. Execute collective operation of choice on this communicator:

    auto request = comm.allreduce(...);
    request->wait();