Class ApiController

java.lang.Object

com.knezevic.edaf.v3.web.controller.ApiController

@RestController
@RequestMapping("/api")
public class ApiController
extends Object

REST API for polling dashboard updates.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ApiController.BulkDeleteItemResult	API payload for one bulk delete item.
static final record	ApiController.BulkDeleteRequest	API payload for bulk delete request.
static final record	ApiController.BulkDeleteResponse	API payload for bulk delete summary.
static final record	ApiController.DeleteExperimentResponse	API payload for one hard-delete experiment operation.
static final record	ApiController.StopRequestBody	API payload for cooperative stop requests.
static final record	ApiController.StopResponse	API payload for stop request result.

Constructor Summary

Constructors

Constructor	Description
ApiController(RunRepository runRepository, CocoRepository cocoRepository, RunArtifactService runArtifactService, GrammarTreeViewService grammarTreeViewService, DashboardStatsService dashboardStatsService)

Method Summary

Modifier and Type	Method	Description
ProblemComparisonReport	compareProblemAlgorithms(String problemType, String direction, Double target, List<String> algorithms)
org.springframework.http.ResponseEntity<String>	compareProblemAlgorithmsLatex(String problemType, String direction, Double target, List<String> algorithms)
DashboardStatsService.DashboardSummary	dashboardSummary()
ApiController.DeleteExperimentResponse	deleteExperiment(String experimentId)
ApiController.BulkDeleteResponse	deleteExperimentsBulk(ApiController.BulkDeleteRequest request)
ExperimentAnalytics	experimentAnalytics(String experimentId, String direction, Double target)
org.springframework.http.ResponseEntity<String>	experimentLatex(String experimentId, String direction, Double target)
FilterFacets	facets()
CocoCampaignDetail	getCocoCampaign(String campaignId)
ExperimentDetail	getExperiment(String experimentId)
RunDetail	getRun(String runId)
GrammarTreeViewService.GrammarTreeView	getRunTree(String runId)
List<CheckpointRow>	listCheckpoints(String runId)
List<CocoAggregateMetric>	listCocoAggregates(String campaignId)
PageResult<CocoCampaignListItem>	listCocoCampaigns(String q, String status, String suite, int page, int size, String sortBy, String sortDir)
List<CocoOptimizerConfigRow>	listCocoOptimizers(String campaignId)
PageResult<CocoTrialMetric>	listCocoTrials(String campaignId, String optimizer, Integer functionId, Integer dimension, Boolean reachedTarget, int page, int size)
PageResult<EventRow>	listEvents(String runId, String eventType, String q, int page, int size)
PageResult<ExperimentRunItem>	listExperimentRuns(String experimentId, int page, int size, String sortBy, String sortDir)
PageResult<ExperimentListItem>	listExperiments(String q, String algorithm, String model, String problem, String status, String from, String to, int page, int size, String sortBy, String sortDir)
List<IterationMetric>	listIterations(String runId)
List<ExperimentParamRow>	listParams(String runId)
PageResult<RunListItem>	listRuns(String q, String algorithm, String model, String problem, String status, String from, String to, Double minBest, Double maxBest, int page, int size, String sortBy, String sortDir)
ApiController.StopResponse	stopExperiment(String experimentId, ApiController.StopRequestBody body)
ApiController.StopResponse	stopRun(String runId, ApiController.StopRequestBody body)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ApiController

public ApiController(RunRepository runRepository,
 CocoRepository cocoRepository,
 RunArtifactService runArtifactService,
 GrammarTreeViewService grammarTreeViewService,
 DashboardStatsService dashboardStatsService)

Method Details

dashboardSummary

@GetMapping("/dashboard/summary")
public DashboardStatsService.DashboardSummary dashboardSummary()

listExperiments

@GetMapping("/experiments")
public PageResult<ExperimentListItem> listExperiments(@RequestParam(required=false)
 String q,
 @RequestParam(required=false)
 String algorithm,
 @RequestParam(required=false)
 String model,
 @RequestParam(required=false)
 String problem,
 @RequestParam(required=false)
 String status,
 @RequestParam(required=false)
 String from,
 @RequestParam(required=false)
 String to,
 @RequestParam(defaultValue="0")
 int page,
 @RequestParam(defaultValue="25")
 int size,
 @RequestParam(defaultValue="latest_run_time")
 String sortBy,
 @RequestParam(defaultValue="desc")
 String sortDir)

listRuns

@GetMapping("/runs")
public PageResult<RunListItem> listRuns(@RequestParam(required=false)
 String q,
 @RequestParam(required=false)
 String algorithm,
 @RequestParam(required=false)
 String model,
 @RequestParam(required=false)
 String problem,
 @RequestParam(required=false)
 String status,
 @RequestParam(required=false)
 String from,
 @RequestParam(required=false)
 String to,
 @RequestParam(required=false)
 Double minBest,
 @RequestParam(required=false)
 Double maxBest,
 @RequestParam(defaultValue="0")
 int page,
 @RequestParam(defaultValue="25")
 int size,
 @RequestParam(defaultValue="start_time")
 String sortBy,
 @RequestParam(defaultValue="desc")
 String sortDir)

getRun

@GetMapping("/runs/{runId}")
public RunDetail getRun(@PathVariable
 String runId)

getRunTree

@GetMapping("/runs/{runId}/tree")
public GrammarTreeViewService.GrammarTreeView getRunTree(@PathVariable
 String runId)

listIterations

@GetMapping("/runs/{runId}/iterations")
public List<IterationMetric> listIterations(@PathVariable
 String runId)

listEvents

@GetMapping("/runs/{runId}/events")
public PageResult<EventRow> listEvents(@PathVariable
 String runId,
 @RequestParam(required=false)
 String eventType,
 @RequestParam(required=false)
 String q,
 @RequestParam(defaultValue="0")
 int page,
 @RequestParam(defaultValue="25")
 int size)

listCheckpoints

@GetMapping("/runs/{runId}/checkpoints")
public List<CheckpointRow> listCheckpoints(@PathVariable
 String runId)

listParams

@GetMapping("/runs/{runId}/params")
public List<ExperimentParamRow> listParams(@PathVariable
 String runId)

facets

@GetMapping("/facets")
public FilterFacets facets()

getExperiment

@GetMapping("/experiments/{experimentId}")
public ExperimentDetail getExperiment(@PathVariable
 String experimentId)

deleteExperiment

@DeleteMapping("/experiments/{experimentId}")
public ApiController.DeleteExperimentResponse deleteExperiment(@PathVariable
 String experimentId)

deleteExperimentsBulk

@PostMapping("/experiments/delete-bulk")
public ApiController.BulkDeleteResponse deleteExperimentsBulk(@RequestBody
 ApiController.BulkDeleteRequest request)

stopRun

@PostMapping("/runs/{runId}/stop")
public ApiController.StopResponse stopRun(@PathVariable
 String runId,
 @RequestBody(required=false)
 ApiController.StopRequestBody body)

stopExperiment

@PostMapping("/experiments/{experimentId}/stop")
public ApiController.StopResponse stopExperiment(@PathVariable
 String experimentId,
 @RequestBody(required=false)
 ApiController.StopRequestBody body)

listExperimentRuns

@GetMapping("/experiments/{experimentId}/runs")
public PageResult<ExperimentRunItem> listExperimentRuns(@PathVariable
 String experimentId,
 @RequestParam(defaultValue="0")
 int page,
 @RequestParam(defaultValue="50")
 int size,
 @RequestParam(defaultValue="start_time")
 String sortBy,
 @RequestParam(defaultValue="desc")
 String sortDir)

experimentAnalytics

@GetMapping("/experiments/{experimentId}/analysis")
public ExperimentAnalytics experimentAnalytics(@PathVariable
 String experimentId,
 @RequestParam(required=false)
 String direction,
 @RequestParam(required=false)
 Double target)

experimentLatex

@GetMapping(value="/experiments/{experimentId}/latex",
            produces="text/plain")
public org.springframework.http.ResponseEntity<String> experimentLatex(@PathVariable
 String experimentId,
 @RequestParam(required=false)
 String direction,
 @RequestParam(required=false)
 Double target)

compareProblemAlgorithms

@GetMapping("/analysis/problem/{problemType}")
public ProblemComparisonReport compareProblemAlgorithms(@PathVariable
 String problemType,
 @RequestParam(required=false)
 String direction,
 @RequestParam(required=false)
 Double target,
 @RequestParam(name="algorithm",required=false)
 List<String> algorithms)

compareProblemAlgorithmsLatex

@GetMapping(value="/analysis/problem/{problemType}/latex",
            produces="text/plain")
public org.springframework.http.ResponseEntity<String> compareProblemAlgorithmsLatex(@PathVariable
 String problemType,
 @RequestParam(required=false)
 String direction,
 @RequestParam(required=false)
 Double target,
 @RequestParam(name="algorithm",required=false)
 List<String> algorithms)

listCocoCampaigns

@GetMapping("/coco/campaigns")
public PageResult<CocoCampaignListItem> listCocoCampaigns(@RequestParam(required=false)
 String q,
 @RequestParam(required=false)
 String status,
 @RequestParam(required=false)
 String suite,
 @RequestParam(defaultValue="0")
 int page,
 @RequestParam(defaultValue="25")
 int size,
 @RequestParam(defaultValue="created_at")
 String sortBy,
 @RequestParam(defaultValue="desc")
 String sortDir)

getCocoCampaign

@GetMapping("/coco/campaigns/{campaignId}")
public CocoCampaignDetail getCocoCampaign(@PathVariable
 String campaignId)

listCocoOptimizers

@GetMapping("/coco/campaigns/{campaignId}/optimizers")
public List<CocoOptimizerConfigRow> listCocoOptimizers(@PathVariable
 String campaignId)

listCocoAggregates

@GetMapping("/coco/campaigns/{campaignId}/aggregates")
public List<CocoAggregateMetric> listCocoAggregates(@PathVariable
 String campaignId)

listCocoTrials

@GetMapping("/coco/campaigns/{campaignId}/trials")
public PageResult<CocoTrialMetric> listCocoTrials(@PathVariable
 String campaignId,
 @RequestParam(required=false)
 String optimizer,
 @RequestParam(required=false)
 Integer functionId,
 @RequestParam(required=false)
 Integer dimension,
 @RequestParam(required=false)
 Boolean reachedTarget,
 @RequestParam(defaultValue="0")
 int page,
 @RequestParam(defaultValue="25")
 int size)