FLParameter

import com.mindspore.flclient.FLParameter

FLParameter is used to define parameters related to federated learning.

Public Member Functions

Function
public static synchronized FLParameter getInstance()
public String getHostName()
public void setHostName(String hostName)
public String getCertPath()
public void setCertPath(String certPath)
public boolean isUseHttps()
public void setUseHttps(boolean useHttps)
public String getTrainDataset()
public void setTrainDataset(String trainDataset)
public String getVocabFile()
public void setVocabFile(String vocabFile)
public String getIdsFile()
public void setIdsFile(String idsFile)
public String getTestDataset()
public void setTestDataset(String testDataset)
public String getFlName()
public void setFlName(String flName)
public String getTrainModelPath()
public void setTrainModelPath(String trainModelPath)
public String getInferModelPath()
public void setInferModelPath(String inferModelPath)
public String getIp()
public void setIp(String ip)
public boolean isUseSSL()
public void setUseSSL(boolean useSSL)
public int getPort()
public void setPort(int port)
public int getTimeOut()
public void setTimeOut(int timeOut)
public int getSleepTime()
public void setSleepTime(int sleepTime)
public boolean isUseElb()
public void setUseElb(boolean useElb)
public int getServerNum()
public void setServerNum(int serverNum)
public String getClientID()
public void setClientID(String clientID)

getInstance

public static synchronized FLParameter getInstance()

Obtains a single FLParameter instance.

• Return value

  Single object of the FLParameter type.

getHostName

public String getHostName()

Obtains the hostname set by a user.

• Return value

  Hostname of the string type.

setHostName

public void setHostName(String hostName)

Sets the hostname.

• Parameter

  • hostName: hostname.

getCertPath

public String getCertPath()

Obtains the certificate path set by a user.

• Return value

  Certificate path of the string type.

setCertPath

public void setCertPath(String certPath)

Sets the certificate path.

• Parameter

  • certPath: certificate path.

isUseHttps

public boolean isUseHttps()

Determines whether the HTTPS communication mode is used for device-cloud communication.

• Return value

  Boolean type. The value true indicates HTTPS communication, and the value false indicates HTTP communication. The default value is false. Currently, the cloud does not support HTTPS communication.

setUseHttps

 public void setUseHttps(boolean useHttps)

Determines whether to use the HTTPS communication mode for device-cloud communication.

• Parameter

  • useHttps: determines whether to use the HTTPS communication mode.

getTrainDataset

public String getTrainDataset()

Obtains the training dataset path set by a user.

• Return value

  Training dataset path of the string type.

setTrainDataset

public void setTrainDataset(String trainDataset)

Sets the training dataset path.

• Parameter

  • trainDataset: training dataset path.

getVocabFile

public String getVocabFile()

Obtains the path of the dictionary file for data preprocessing, which is set by a user.

• Return value

  Path of the dictionary file for preprocessing data, which is of the string type.

setVocabFile

public void setVocabFile(String vocabFile)

Sets the path of the dictionary file for data preprocessing.

• Parameter

  • vocabFile: path of the dictionary file for data preprocessing.

getIdsFile

public String getIdsFile()

Obtains the path of the mapping ID file of a dictionary set by a user.

• Return value

  Path of the mapping ID file of a dictionary of the string type.

setIdsFile

public void setIdsFile(String idsFile)

Sets the path of the mapping ID file of a dictionary.

• Parameter

  • idsFile: path of the mapping ID file of a dictionary.

getTestDataset

public String getTestDataset()

Obtains the path of the test dataset set by a user.

• Return value

  Path of the test dataset of the string type.

setTestDataset

public void setTestDataset(String testDataset)

Sets the path of the test dataset.

• Parameter

  • testDataset: path of the test dataset.

getFlName

public String getFlName()

Obtains the model name set by a user.

• Return value

  Name of a model of the string type.

setFlName

public void setFlName(String flName)

Sets the model name.

• Parameter

  • flName: model name.

getTrainModelPath

public String getTrainModelPath()

Obtains the path of the training model set by a user.

• Return value

  Path of the training model of the string type.

setTrainModelPath

public void setTrainModelPath(String trainModelPath)

Sets the path of the training model.

• Parameter

  • trainModelPath: training model path.

getInferModelPath

public String getInferModelPath()

Obtains the path of the inference model set by a user.

• Return value

  Path of the inference model of the string type.

setInferModelPath

public void setInferModelPath(String inferModelPath)

Sets the path of the inference model.

• Parameter

  • inferModelPath: path of the inference model.

getIp

public String getIp()

Obtains the IP address set by a user for device-cloud communication.

• Return value

  IP address of the string type.

setIp

public void setIp(String ip)

Sets the IP address for device-cloud communication.

• Parameter

  • ip: IP address for device-cloud communication.

isUseSSL

public boolean isUseSSL()

Determines whether SSL certificate authentication is performed for device-cloud communication.

• Return value

  The value is of the Boolean type. The value true indicates that SSL certificate authentication is performed, and the value false indicates that SSL certificate authentication is not performed.

setUseSSL

public void setUseSSL(boolean useSSL)

Determines whether to perform SSL certificate authentication (which applies only to the HTTPS communication scenario) for device-cloud communication.

• Parameter

  • useSSL: determines whether to perform SSL certificate authentication for device-cloud communication.

getPort

public int getPort()

Obtains the port number set by a user for device-cloud communication.

• Return value

  Port number for device-cloud communication, which is an integer.

setPort

public void setPort(int port)

Sets the port number for device-cloud communication.

• Parameter

  • port: port number for device-cloud communication.

getTimeOut

public int getTimeOut()

Obtains the timeout interval set by a user for device-side communication.

• Return value

  Timeout interval for communication on the device, which is an integer.

setTimeOut

public void setTimeOut(int timeOut)

Sets the timeout interval for communication on the device.

• Parameter

  • timeOut: timeout interval for communication on the device.

getSleepTime

public int getSleepTime()

Obtains the waiting time of repeated requests set by a user.

• Return value

  Waiting time of repeated requests, which is an integer.

setSleepTime

public void setSleepTime(int sleepTime)

Sets the waiting time of repeated requests.

• Parameter

  • sleepTime: waiting time for repeated requests.

isUseElb

public boolean isUseElb()

Determines whether the elastic load balancing is simulated, that is, whether a client randomly sends requests to a server address within a specified range.

• Return value

  The value is of the Boolean type. The value true indicates that the client sends requests to a random server address within a specified range. The value false indicates that the client sends a request to a fixed server address.

setUseElb

public void setUseElb(boolean useElb)

Determines whether to simulate the elastic load balancing, that is, whether a client randomly sends a request to a server address within a specified range.

• Parameter

  • useElb: determines whether to simulate the elastic load balancing. The default value is false.

getServerNum

public int getServerNum()

Obtains the number of servers that can send requests when simulating the elastic load balancing.

• Return value

  Number of servers that can send requests during elastic load balancing simulation, which is an integer.

setServerNum

public void setServerNum(int serverNum)

Sets the number of servers that can send requests during elastic load balancing simulation.

• Parameter

  • serverNum: number of servers that can send requests during elastic load balancing simulation. The default value is 1.

getClientID

public String getClientID()

Obtains the unique client ID set by a user.

• Return value

  Unique ID of the client, which is of the string type.

setClientID

public void setClientID(String clientID)

Sets the unique ID of a client.

• Parameter

  • clientID: unique ID of a client.