io.cortical.services

Interface Compare

public interface Compare

The Compare Retina API.

Method Summary

Methods

Modifier and Type	Method and Description
Metric	compare(Model model1, Model model2) Compare 2 models.
Metric	compare(String jsonModel1, Model model2) Compare 2 models.
Metric	compare(String jsonModel1, String jsonModel2) Compare 2 models.

Method Detail

compare

Metric compare(Model model1,
             Model model2)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      ApiException

Compare 2 models.

Parameters:

model1 - : model to be compared with model2

model2 - : model to be compared with model1

Returns:

the result of the comparison as a @{link Metric} object.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - : if the models cannot be converted to JSON.

ApiException - : if the cortical.io's API isn't available/ or an internal error occurred.

compare

Metric compare(String jsonModel1,
             Model model2)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      ApiException

Compare 2 models.

Parameters:

jsonModel1 - : json (string) model to be compared with model2

model2 - : model to be compared with jsonModel1

Returns:

the result of the comparison as a @{link Metric} object.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - : if the models cannot be converted to JSON.

ApiException - : if the cortical.io's API isn't available/ or an internal error occurred.

compare

Metric compare(String jsonModel1,
             String jsonModel2)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      ApiException

Compare 2 models.

Parameters:

jsonModel1 - : json model to be compared with model2

jsonModel2 - : json model to be compared with model1

Returns:

the result of the comparison as a @{link Metric} object.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - : if the models cannot be converted to JSON.

ApiException - : if the cortical.io's API isn't available/ or an internal error occurred.