itszootime / emulatorization-api Goto Github PK

These classes share a lot of similar code (especially since normalisation is added), and should be refactored. Design and process evaluation results are essentially the same, but one for input, one for output. Emulator evaluation result has mean and covariance values instead of a single one.

At the moment the config is loaded from et.yml, and a number of locations are searched for this file. It should be possible for a user to set the required parameters for the API themselves, either by supplying their own file (by location), or using setters on the Config object.

At the moment the complete design is sent to MATLAB, which then takes n random points from the design (where n is specified training size in the original API request). This is inefficient, and should either be done at the site level (remove training size parameter from API), or API level (select randomly before sending to MATLAB).

Try a million.

If an input is not sent in a screening/evaluation/etc request, the input variable on line 86 in PSProcessEvaluator will be null. Need to handle this gracefully.

Treats the value as mean, variance from whole collection. Class might not even be needed if we don't support scalar vs. scalar validations.

Is there a reason we can't use ps-framework for exposing the API functionality? It seems like it would be a good use case.

When sending a large amount of requests to a service, it might not be too wise to simply send as fast as possible. This could trigger DDoS protection, or make people unhappy! It could be better to wait for say, 5 seconds between each block of requests.

It relies on the ordering of the input identifiers to build the matrix. Have added a method which lets you supply a List containing the inputs (and order of inputs) for the matrix, but need to check proper usage.

If I want to add data to a returned JSON object at the moment (e.g. for validation), I have to add a field to the class doing the calculation, associated getter, add a field to the response class, associated getting and setter, and finally the static from method.

It would be possible to have the calculation class implement a Returnable interface, and have some sort of annotation to specify fields to return? Or use the in-built Gson features for specific field serialization. It will most likely need the interface so Gson can identify when it needs to add a type: 'SomethingResponse' field.

Rather than being extra emulator parameters.

Could use NumericValues for Ensemble members field, might make the class more complicated to use?