Identify components needing a front-end UI

[jkglasbrenner]

Process Notes

Things that should be incorporated into the work process:

• Mockup process using Balsamiq (or other tool if decided)
• Identify resources/objects needed from the REST API endpoints

Definition of Done

• [x] Identified all existing endpoints and functionality that should be provided with a front-end UI
• [x] Created issue cards for the tasks needed to design and implement the front-end UI components

[andrewhand]

UI Components Overview

• Home Page
  • Desc. of Dioptra
    • Abstract
    • Overview of archtecture
    • Brief example (image/video of a low level demo)
  • Relavent Links
    • Docs
    • Tutorials
    • Contact us
• Virtual Lab
  • REST API Endpoint library
  • Data set library
  • Logs to mimic MLflow
  • Results page
    • Metrics
    • Data visualizations
  • Debugger
    • Inspect data points (images, sounds, artifacts, etc.)
    • Possible interface with both Logs and Results page
  • Experiment library
    • Entry point library
      • Task plugin library
• Experiment Constructor
  • Form for generating a cookiecutter template
    • List of entry points
      • List of task plugins
        • List of dependencies
          • Give library of supported dependencies (already in docker images)
          • Interface for adding new dependencies
  • Entry point and task plugin preview
    • Possible visualization (such as a flow chart) to show when/how each entry point and task plugin will be used
  • Create issue card and/or new dioptra branch for new demo

[andrewhand]

Registry of Entrypoints (for note purposes)

• Current Demos
  • [ ] basic-mlflow-demo
    • [ ] hello_world
    • [ ] load_model_dataset
    • [ ] log
  • [ ] patch-defended-pixel-threshold
    • [ ] attacks
    • [ ] data
    • [ ] init_model
    • [ ] log
    • [ ] metrics
    • [ ] models
    • [ ] patch
    • [ ] pt
  • [ ] pytorch-detectron2-demo
    • [ ] poison_train
    • [ ] test
    • [ ] train
  • [ ] pytorch-mnist-membership-inference
    • [ ] mi
    • [ ] train_mi
  • [ ] pytorch-robust-dpatch
    • [ ] attack
  • [ ] tensorflow-adversarial-patches
    • [ ] deploy_patch
    • [ ] gaussian_augmentation
    • [ ] generate_patch
    • [ ] infer
    • [ ] init_model
    • [ ] jpeg_compression
    • [ ] spatial_smoothing
    • [ ] train
  • [ ] tensorflow-backdoor-poisoning
    • [ ] deploy_poison_data
    • [ ] gaussian_augmentation
    • [ ] gen_poison_clean_data
    • [ ] gen_poison_data
    • [ ] gen_poison_model
    • [ ] infer
    • [ ] init_model
    • [ ] jpeg_compression
    • [ ] spatial_smoothing
    • [ ] train
    • [ ] train_with_madry_pgd_defense
  • [ ] tensorflow-imagenet-pixel-threshold
    • [ ] attacks
    • [ ] data
    • [ ] init_model
    • [ ] log
    • [ ] metrics
    • [ ] models
    • [ ] pt
    • [ ] train
  • [ ] tensorflow-imagenet-resnet50-fgm
    • [ ] fgm
    • [ ] gaussian_augmentation
    • [ ] infer
    • [ ] init_model
    • [ ] jpeg_compression
    • [ ] spatial_smoothing
    • [ ] train
  • [ ] tensorflow-mnist-classifier
    • [ ] fgm
    • [ ] infer
    • [ ] train
  • [ ] tensorflow-mnist-feature-squeezing
    • [ ] attacks
    • [ ] cw
    • [ ] cw_inf
    • [ ] cw_l2
    • [ ] data
    • [ ] data_res
    • [ ] deepfool
    • [ ] feature_squeeze
    • [ ] fgm
    • [ ] fgm_defended
    • [ ] import_keras
    • [ ] infer
    • [ ] infer_defended
    • [ ] init_model
    • [ ] jsma
    • [ ] log
    • [ ] metrics
    • [ ] models
    • [ ] tasks
    • [ ] train
  • [ ] tensorflow-mnist-model-inversion
    • [ ] mi
    • [ ] train
  • [ ] tensorflow-mnist-pixel-threshold
    • [ ] infer
    • [ ] pt
    • [ ] train
  • [ ] tensorflow-roadsigns-yolo
    • [ ] infer
    • [ ] transfer_learn

[andrewhand]

UI Components - REST API Endpoints

• Experiment
  • Displays
    • [ ] GET /api/experiment/ Gets a list of all registered experiments
    • [ ] GET /api/experiment/name/{experimentName} Gets an experiment by its unique name
  • Utilities
    • [ ] POST /api/experiment/ Creates a new experiment via an experiment registration form
    • [ ] PUT /api/experiment/{experimentId} Modifies an experiment by its unique identifier
    • [ ] DELETE /api/experiment/name/{experimentName} Deletes an experiment by its unique name
    • [ ] PUT /api/experiment/name/{experimentName} Modifies an experiment by its unique name
• Jobs
  • Displays
    • [ ] GET /api/job/ Gets a list of all submitted jobs
    • [ ] GET /api/job/{jobId} Gets a job by its unique identifier
  • Utilities
    • [ ] POST /api/job/ Creates a new job via a job submission form with an attached file
• Queue
  • Displays
    • [ ] GET /api/queue/ Gets a list of all registered queues
    • [ ] GET /api/queue/{queueId} Gets a queue by its unique identifier
    • [ ] GET /api/queue/name/{queueName} Gets a queue by its unique name
  • Utilities
    • [ ] POST /api/queue/ Creates a new queue via a queue registration form
    • [ ] DELETE /api/queue/{queueId} Deletes a queue by its unique identifier
    • [ ] PUT /api/queue/{queueId} Modifies a queue by its unique identifier
    • [ ] DELETE /api/queue/{queueId}/lock Removes the lock from the queue (id reference) if it exists
    • [ ] PUT /api/queue/{queueId}/lock Locks the queue (id reference) if it is unlocked
    • [ ] DELETE /api/queue/name/{queueName} Deletes a queue by its unique name
    • [ ] PUT /api/queue/name/{queueName} Modifies a queue by its unique name
    • [ ] DELETE /api/queue/name/{queueName}/lock Removes the lock from the queue (name reference) if it exists
    • [ ] PUT /api/queue/name/{queueName}/lock Locks the queue (name reference) if it is unlocked
• Task Plugin
  • Displays
    • [ ] GET /api/taskPlugin/ Gets a list of all registered task plugins
    • [ ] GET /api/taskPlugin/dioptra_builtins/{taskPluginName} Gets a builtin task plugin by its unique name
    • [ ] GET /api/taskPlugin/dioptra_custom/{taskPluginName} Gets a custom task plugin by its unique name
  • Utilities
    • [ ] POST /api/taskPlugin/ Registers a new task plugin uploaded via the task plugin upload form
    • [ ] DELETE /api/taskPlugin/dioptra_custom/{taskPluginName} Deletes a custom task plugin by its unique name
• User Management (Admin)
  • Displays
    • [ ] GET api/.../ Get all users
    • [ ] GET api/.../{userName} Get user by their unique name
    • [ ] GET api/.../{privilege} Get all users for a certain privilege level
  • Utilities
    • [ ] POST api/.../{userName} Creates a user with the given name
    • [ ] PUT api/.../{userName} Modifies the user with the given name
    • [ ] DELETE api/.../{userName} Deletes the user with the given name

[hbooth]

Issue Cards created