package remote

Get desktop application:
View/edit binary Protocol Buffers messages

Interface exported by the server.

• rpc rpc_XGDMatrixCreateFromEncryptedFile (DMatrixAttrsRequest, Name)

  remote.proto:25

  Send params of a DMatrix to the server for initialization Returns the name assigned to this DMatrix

  message DMatrixAttrsRequest

  remote.proto:104

  Wrapper around DMatrixAttrs to include sequence number

  • optional DMatrixAttrs params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGBoosterCreate (BoosterAttrsRequest, Name)

  remote.proto:29

  Send params of a Booster to the server for initialization Returns the name assigned to this booster

  message BoosterAttrsRequest

  remote.proto:124

  Wrapper around BoosterAttrs to include sequence number

  • optional BoosterAttrs params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGBoosterSetParam (BoosterParamRequest, StatusMsg)

  remote.proto:32

  Set booster parameters

  message BoosterParamRequest

  remote.proto:145

  Wrapper around BoosterParam to include sequence number

  • optional BoosterParam params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGBoosterUpdateOneIter (BoosterUpdateParamsRequest, StatusMsg)

  remote.proto:35

  Update the booster for one round

  message BoosterUpdateParamsRequest

  remote.proto:165

  • optional BoosterUpdateParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGBoosterPredict (PredictParamsRequest, Predictions)

  remote.proto:38

  Run predictions

  message PredictParamsRequest

  remote.proto:197

  Wrapper around PredictParams to include sequence number

  • optional PredictParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

  message Predictions

  remote.proto:379

  Encrypted predictions served by enclave, to be decrypted at client

  • repeated numproto.protobuf.NDArray predictions = 1

    Encrypted predictions

  • repeated uint32 num_preds = 2

    Length of predictions

  • optional Status status = 3

    Status

  • repeated numproto.protobuf.NDArray signatures = 4

  • repeated uint32 sig_lens = 5

• rpc rpc_XGBoosterSaveModel (SaveModelParamsRequest, StatusMsg)

  remote.proto:41

  Save model to a file on the server

  message SaveModelParamsRequest

  remote.proto:217

  Wrapper around SaveModelParams to include sequence number

  • optional SaveModelParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGBoosterLoadModel (LoadModelParamsRequest, StatusMsg)

  remote.proto:44

  Load model from file on the server

  message LoadModelParamsRequest

  remote.proto:237

  Wrapper around LoadModelParams to include sequence number

  • optional LoadModelParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGBoosterDumpModelEx (DumpModelParamsRequest, Dump)

  remote.proto:47

  Dump model

  message DumpModelParamsRequest

  remote.proto:259

  Wrapper around DumpModelParams to include sequence number

  • optional DumpModelParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGBoosterDumpModelExWithFeatures (DumpModelWithFeaturesParamsRequest, Dump)

  remote.proto:50

  Dump model with features

  message DumpModelWithFeaturesParamsRequest

  remote.proto:282

  • optional DumpModelWithFeaturesParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGBoosterGetModelRaw (ModelRawParamsRequest, Dump)

  remote.proto:53

  Save model to buffer

  message ModelRawParamsRequest

  remote.proto:300

  • optional ModelRawParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGDMatrixNumCol (NumColRequest, Integer)

  remote.proto:56

  Get number of columns in the DMatrix

  message NumColRequest

  remote.proto:343

  • optional NameRequestParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_XGDMatrixNumRow (NumRowRequest, Integer)

  remote.proto:59

  Get number of rows in the DMatrix

  message NumRowRequest

  remote.proto:356

  • optional NameRequestParams params = 1

  • optional SequenceNumber seq_num = 2

  • string username = 3

  • optional numproto.protobuf.NDArray signature = 4

  • uint32 sig_len = 5

  • repeated string signers = 6

    Orchestrator will collect and deliver the below to each enclave in the cluster

  • repeated numproto.protobuf.NDArray signatures = 7

  • repeated uint32 sig_lengths = 8

• rpc rpc_RabitInit (RabitParams, StatusMsg)

  remote.proto:62

  Initialize Rabit

• rpc rpc_RabitFinalize (RabitParams, StatusMsg)

  remote.proto:65

  Finalize Rabit

Params for the constructor of a Booster

Used in: BoosterAttrsRequest

• repeated string cache = 1

• uint64 length = 2

Booster parameter

Used in: BoosterParamRequest

• string booster_handle = 1

• string key = 2

• string value = 3

Params for training

Used in: BoosterUpdateParamsRequest

• string booster_handle = 1

• string dtrain_handle = 2

• uint32 iteration = 3

Params for the constructor of a DMatrix

Used in: DMatrixAttrsRequest

• repeated string filenames = 1

• repeated string usernames = 2

• uint32 silent = 3

Model dump

Used as response type in: Remote.rpc_XGBoosterDumpModelEx, Remote.rpc_XGBoosterDumpModelExWithFeatures, Remote.rpc_XGBoosterGetModelRaw

• repeated string sarr = 1

• uint64 length = 2

• optional Status status = 3

• optional numproto.protobuf.NDArray signature = 4

• uint32 sig_len = 5

Params for dump model

Used in: DumpModelParamsRequest

• string booster_handle = 1

• string fmap = 2

• uint32 with_stats = 3

• string dump_format = 4

Params for dump model with features

Used in: DumpModelWithFeaturesParamsRequest

• string booster_handle = 1

• uint32 flen = 2

• repeated string fname = 3

• repeated string ftype = 4

• uint32 with_stats = 5

• string dump_format = 6

Integer

Used as response type in: Remote.rpc_XGDMatrixNumCol, Remote.rpc_XGDMatrixNumRow

• uint32 value = 1

• optional Status status = 2

  Status of call (for returned Integer)

• optional numproto.protobuf.NDArray signature = 3

• uint32 sig_len = 4

Params for load model

Used in: LoadModelParamsRequest

• string booster_handle = 1

• string filename = 2

Params for dump model

Used in: ModelRawParamsRequest

• string booster_handle = 1

Used as response type in: Remote.rpc_XGBoosterCreate, Remote.rpc_XGDMatrixCreateFromEncryptedFile

• string name = 1

  Name that the server assigned the handle

• string username = 2

• optional numproto.protobuf.NDArray signature = 3

  Status of call (for returned Name)

• uint32 sig_len = 4

• optional Status status = 5

// Pair of strings message Pair { string x = 1; string y = 2; }

Used in: NumColRequest, NumRowRequest

• string name = 1

  Name that the server assigned the handle

// Params for eval message BoosterEvalSetParams { string handle = 1; repeated Pair evals = 2; uint32 iteration = 3; numproto.protobuf.NDArray signature = 4; uint32 sig_len = 5; } Params for prediction

Used in: PredictParamsRequest

• string booster_handle = 1

• string dmatrix_handle = 2

• uint32 option_mask = 3

• uint32 ntree_limit = 4

• uint32 training = 5

// Params for distributed training message ClusterParams { // Number of nodes in cluster uint32 num_workers = 1; }

Used as request type in: Remote.rpc_RabitFinalize, Remote.rpc_RabitInit

• optional Status params = 1

  Dummy parameter for compatibility

• string username = 2

• optional SequenceNumber seq_num = 3

• optional numproto.protobuf.NDArray signature = 4

• uint32 sig_len = 5

• repeated string signers = 6

• repeated numproto.protobuf.NDArray signatures = 7

• repeated uint32 sig_lengths = 8

Params for save model

Used in: SaveModelParamsRequest

• string booster_handle = 1

• string filename = 2

Used in: BoosterAttrsRequest, BoosterParamRequest, BoosterUpdateParamsRequest, DMatrixAttrsRequest, DumpModelParamsRequest, DumpModelWithFeaturesParamsRequest, LoadModelParamsRequest, ModelRawParamsRequest, NumColRequest, NumRowRequest, PredictParamsRequest, RabitParams, SaveModelParamsRequest

• optional numproto.protobuf.NDArray nonce = 1

  k byte random number generated at the start of the session

• uint32 nonce_size = 2

  Size of nonce (k = 12, or CIPHER_IV_SIZE)

• uint32 nonce_ctr = 3

  4 byte counter that increments with each synchronized function call

Current status of the node

Used in: Dump, Integer, Name, Predictions, RabitParams, StatusMsg

• int32 status = 1

  Status

• string exception = 2

  Exception message

Current status of the node

Used as response type in: Remote.rpc_RabitFinalize, Remote.rpc_RabitInit, Remote.rpc_XGBoosterLoadModel, Remote.rpc_XGBoosterSaveModel, Remote.rpc_XGBoosterSetParam, Remote.rpc_XGBoosterUpdateOneIter

• optional Status status = 1

  Status

• optional numproto.protobuf.NDArray signature = 2

• uint32 sig_len = 3