rhino-health 0.2.4

Standard Development Kit for interacting with the Rhino Health Federated Learning Platform

Rhino Health SDK

Programmatic interface for interacting with the Rhino Health Federated Learning Platform.

Example Usage

Please see the sample notebook files provided to you by the Rhino Health Team for additional use cases.

Create a session

import rhino_health

my_username = "[e-mail]" # Replace me
my_password = "ASecurePasswordYouSet321" # Replace me
session = rhino_health.login(username=my_username, password=my_password)

There will be three ways to interact with the API after you have a session

1. Use defined endpoints under lib/endpoints for single actions
2. Use our library functions for commonly performed advanced features
3. Use our low level API Interface (advanced users)

Interact with the API via defined endpoints

We've included convenience functions for our most commonly used endpoints in the library with required input and output data classes. These can be found in rhino_health/lib/endpoints.

my_projects = session.project.get_projects()
my_first_project = my_projects[0]
my_first_project.add_collaborator(collaborating_workgroup_uid)

my_cohort = session.cohort.get_cohort(my_cohort_uid)
cohort_project = my_cohort.project
my_cohort_info = my_cohort.cohort_info

Library Functions

RhinoHealth also provides library functions which combine our basic building blocks to perform common actions.

Example:

from rhino_health.lib.metrics import RocAucWithCI

metric_configuration = RocAucWithCI(y_true_variable="label", y_pred_variable="pred", confidence_interval=95, timeout_seconds=600)
"""
data_filters=[{
        "filter_column":"is_roc",
        "filter_value":1
    }]
"""
result = my_cohort.get_metric(metric_configuration)
print(f"{result.output}")

Interact using the low level API

If you would prefer to interact directly with our backend API, you can hit our backend directly using our low level APIs. This option is valid for any endpoints we do not have full SDK support for yet.

session.get("/alpha/secret/api").raw_response.json()
session.post("/alpha/secret/api", {"arbitrary_payload": "value"}).raw_response.json()
# Can also check out .status_code, etc.

Development Notes

Please install libyaml required by our testing library (see https://vcrpy.readthedocs.io/en/latest/installation.html)

brew install libyaml
pip uninstall pyyaml
pip --no-cache-dir install pyyaml

You may need to use pip install -r requirements.txt --no-cache-dir on M1 Macs