Client: Client for the vantage6 infrastructure.

In mellesies/vtg: Utilities for the vantage6 Federated Learning Infrastructure

Client for the vantage6 infrastructure.

Description

Facilitates querying collaborations, creating tasks and retrieving results.

Methods

Public methods

• Client$new()

• Client$authenticate()

• Client$setPrivateKey()

• Client$getVersion()

• Client$getCollaborations()

• Client$getOrganization()

• Client$getCollaboration()

• Client$setCollaborationId()

• Client$setUseEncryption()

• Client$setUseMasterContainer()

• Client$refresh.token()

• Client$request()

• Client$GET()

• Client$POST()

• Client$PUT()

• Client$wait.for.results()

• Client$decrypt.result()

• Client$process.results()

• Client$set.task.image()

• Client$encrypt()

• Client$call()

• Client$repr()

• Client$clone()

---

Method new()

Usage

Client$new(
  host,
  username = "",
  password = "",
  collaboration_id = NULL,
  api_path = ""
)

Arguments

host

character() Host to connect to

username

character() (optional) Username

password

character() (optional) Password

collaboration_id

integer() (optional) Collaboration id

api_path

character() (optional) API path

---

Method authenticate()

Usage

Client$authenticate(username = "", password = "")

Arguments

username

character (optional) Username. If not provided, the username and password provided to the constructor are used.

password

character (optional) Password. Required if username is provided.

---

Method setPrivateKey()

Usage

Client$setPrivateKey(bytes_or_filename)

---

Method getVersion()

Usage

Client$getVersion()

---

Method getCollaborations()

Usage

Client$getCollaborations()

---

Method getOrganization()

Usage

Client$getOrganization(organization_id)

---

Method getCollaboration()

Usage

Client$getCollaboration(collaboration_id)

---

Method setCollaborationId()

Usage

Client$setCollaborationId(collaboration_id)

---

Method setUseEncryption()

Usage

Client$setUseEncryption(flag)

---

Method setUseMasterContainer()

Usage

Client$setUseMasterContainer(flag = T)

---

Method refresh.token()

Usage

Client$refresh.token()

---

Method request()

Usage

Client$request(method, path, data = NULL, first_try = T, prefix.api.path = T)

---

Method GET()

Usage

Client$GET(path, prefix.api.path = T)

---

Method POST()

Usage

Client$POST(path, data = NULL, prefix.api.path = T)

---

Method PUT()

Usage

Client$PUT(path, data = NULL, prefix.api.path = T)

---

Method wait.for.results()

Usage

Client$wait.for.results(task)

---

Method decrypt.result()

Usage

Client$decrypt.result(serialized.output)

---

Method process.results()

Usage

Client$process.results(site_results)

---

Method set.task.image()

Usage

Client$set.task.image(image, task.name = "")

---

Method encrypt()

Usage

Client$encrypt(data, org)

---

Method call()

Usage

Client$call(method, ...)

---

Method repr()

Usage

Client$repr()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Client$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

client <- vtg::Client$new('http://localhost:5000', api_path='/api')
client$authenticate('root', 'password')

collaborations <- client$getCollaborations()
print(collaborations)

client$set.task.image(image.name, task.name="colnames")
result <- client$call("colnames")

mellesies/vtg documentation built on Sept. 15, 2024, 2:32 a.m.