xgboost::federated Namespace Reference

Data Structures
class	FederatedClient
	A wrapper around the gRPC client. More...
class	FederatedService

Functions
void	RunServer (int port, int world_size, char const *server_key_file, char const *server_cert_file, char const *client_cert_file)
void	RunInsecureServer (int port, int world_size)
None	run_federated_server (int port, int world_size, str server_key_path="", str server_cert_path="", str client_cert_path="")

Detailed Description

XGBoost Federated Learning related API.

Function Documentation

run_federated_server()

None xgboost.federated.run_federated_server	(	int	port,
		int	world_size,
		str	server_key_path = "",
		str	server_cert_path = "",
		str	client_cert_path = ""
	)

Run the Federated Learning server.

Parameters
----------
port : int
    The port to listen on.
world_size: int
    The number of federated workers.
server_key_path: str
    Path to the server private key file. SSL is turned off if empty.
server_cert_path: str
    Path to the server certificate file. SSL is turned off if empty.
client_cert_path: str
    Path to the client certificate file. SSL is turned off if empty.