Feat/fastapi

docsrc/quicktour.md

@@ -1,5 +1,31 @@
 # Quick Start
 
+## Application
+We recommend using the browser-based application interface if you are new to probing.
+
+Run the app using:
+```
+python -m probe_ably.app
+```
+
+
+## As a Python Library
+Follow the installation guidelines. 
+
+### Default Probing Configuration
+'''
+from probe_ably import ProbingExperiment
+experiment = ProbingExperiment.from_config("default")
+experiment.representations = data # dataframe, torch tensor or np.array of vector representations
+experiment.labels = labels # array-like
+experiment.run()
+'''
+
+### Custom Probing Configuration
+
+### Custom Probing Configuration with Data Paths
+
+## CLI 
 ## Representation File
 
 The representation file that you are going to test in expected to be a tab seperated `tsv` file with one column for each dimension, separated by \t, last column is assumed to be the label.
@@ -67,8 +93,3 @@ In this configuration file.
 At the end of the probe you will be directed or prompted to visit the following address: `http://127.0.0.1:8031/` where you can see the visualzation output.
 
 By default probing will run the `Linear Model` and `MLP Model` with Accuracy and Selectivity as the default metrics. If you want to change the run configurations of these models see [Probing Configurations](/advanced/configurations.md).
-
-
-
-
-

probe_ably/__init__.py

@@ -0,0 +1 @@
+from .experiment_setup import ProbingExperiment

probe_ably/__main__.py

@@ -0,0 +1,13 @@
+import click
+from probe_ably import ProbingExperiment
+
+@click.command()
+@click.option("--config_file",
+    help="Probing Configuration File",
+    default="./tests/sample_files/test_input/multi_task_multi_model_with_control.json")
+def main(config_file):
+    experiment = ProbingExperiment.from_json(config_file)
+    experiment.run()
+
+if __name__ == "__main__":
+    main()

probe_ably/app/__main__.py

@@ -0,0 +1,85 @@
+from probe_ably.metrics import ProcessMetricTask
+from probe_ably.utils import ReadInputTask
+from probe_ably.probing import TrainProbingTask
+from probe_ably import ProbingExperiment
+from pathlib import Path
+import threading
+import os
+
+from fastapi import FastAPI, UploadFile, File, BackgroundTasks
+from fastapi.staticfiles import StaticFiles
+from fastapi.concurrency import run_in_threadpool
+import uvicorn
+
+app_dir = Path(os.path.abspath(__file__)).parent
+build_dir = app_dir.joinpath('build')
+
+# INPUT_FILE = "./tests/sample_files/test_input/multi_task_multi_model_with_control.json"
+probing_task = TrainProbingTask()
+read_input_task = ReadInputTask()
+process_metric_task = ProcessMetricTask()
+
+
+class ProbingThread(threading.Thread):
+    def __init__(self):
+        super().__init__()
+        self.results = None
+        self.task_loop_bar = None
+        self.reps_loop_bar = None
+        self.probes_loop_bar = None
+
+
+    async def set_config(self, config_file):
+        self.parsed_input = await read_input_task.run(config_file)
+
+
+    def run(self):
+        experiment = ProbingExperiment.from_parsed_input(self.parsed_input, thread=self)
+        results = experiment.run()
+        return results
+
+app = FastAPI()
+app.probing_thread = ProbingThread()
+
+
+@app.post("/start_probing")
+async def start_probing(background_tasks: BackgroundTasks, config_file: UploadFile = File(...), ):
+    await app.probing_thread.set_config(config_file)
+    results = await run_in_threadpool(app.probing_thread.run)
+    return results
+
+
+@app.get('/model_progress')
+def model_progress():
+    bar = app.probing_thread.reps_loop_bar
+    if bar:
+        prog = bar.format_dict
+        return prog
+    else:
+        return {'n': 0, 'total':0}
+
+
+@app.get('/task_progress')
+async def task_progress():
+    bar = app.probing_thread.task_loop_bar
+    if bar:
+        prog = bar.format_dict
+        return prog
+    else:
+        return {'n': 0, 'total':0}
+
+
+@app.get('/probes_progress')
+def probes_progress():
+    bar = app.probing_thread.probes_loop_bar
+    if bar:
+        prog = bar.format_dict
+        return prog
+    else:
+        return {'n': 0, 'total':0}
+
+
+app.mount("/", StaticFiles(directory=build_dir, html = True), name="static")
+
+if __name__ == "__main__":
+    uvicorn.run(app, host="0.0.0.0", port=8000)

probe_ably/service/package.json → probe_ably/app/package.json

@@ -4,11 +4,11 @@
   "private": true,
   "dependencies": {
     "@fortawesome/fontawesome-free": "^5.15.3",
-    "@fortawesome/fontawesome-svg-core": "^1.2.35",
-    "@fortawesome/free-brands-svg-icons": "^5.15.3",
-    "@fortawesome/free-regular-svg-icons": "^5.15.3",
-    "@fortawesome/free-solid-svg-icons": "^5.15.3",
-    "@fortawesome/react-fontawesome": "^0.1.14",
+    "@fortawesome/fontawesome-svg-core": "^1.2.36",
+    "@fortawesome/free-brands-svg-icons": "^5.15.4",
+    "@fortawesome/free-regular-svg-icons": "^5.15.4",
+    "@fortawesome/free-solid-svg-icons": "^5.15.4",
+    "@fortawesome/react-fontawesome": "^0.1.15",
     "@nivo/bar": "^0.73.1",
     "@nivo/core": "^0.73.0",
     "@nivo/line": "^0.73.0",
@@ -17,20 +17,21 @@
     "@testing-library/react": "^12.0.0",
     "@testing-library/user-event": "^13.2.1",
     "@themesberg/react-bootstrap": "^1.4.1",
-    "bootstrap": "5.0.2",
+    "bootstrap": "5.1.0",
     "chartist": "^0.11.4",
     "chartist-plugin-tooltips-updated": "^0.1.4",
+    "core-js": "^3.19.1",
     "jspdf": "^2.3.1",
     "moment-timezone": "^0.5.33",
     "node-sass": "^6.0.1",
     "react": "^17.0.2",
     "react-chartist": "^0.14.4",
-    "react-copy-to-clipboard": "^5.0.3",
+    "react-copy-to-clipboard": "^5.0.4",
     "react-datetime": "^3.0.4",
     "react-dom": "^17.0.2",
     "react-download-svg": "^0.0.4",
-    "react-github-btn": "^1.2.0",
-    "react-live": "^2.2.3",
+    "react-github-btn": "^1.2.1",
+    "react-live": "^2.3.0",
     "react-router-dom": "^5.2.0",
     "react-router-hash-link": "^2.4.3",
     "react-scripts": "4.0.3",
@@ -63,6 +64,5 @@
       "last 1 safari version"
     ]
   },
-  "devDependencies": {
-  }
+  "devDependencies": {}
 }

probe_ably/service/src/charts/LineChartWidget.js → probe_ably/app/src/charts/LineChartWidget.js

@@ -1,16 +1,17 @@
-import { ResponsiveScatterPlot } from "@nivo/scatterplot";
+import { ResponsiveLine } from '@nivo/line';
 import {
   Button,
   ButtonGroup,
   Card,
   Col,
-  Row,
+  Row
 } from "@themesberg/react-bootstrap";
 import { jsPDF } from "jspdf";
 import React, { useEffect, useRef } from "react";
 import ReactDOM from "react-dom";
 import "svg2pdf.js";
 
+
 export default (props) => {
   const { title, probing_data, task_name } = props;
   const linechartRefs = useRef([]);
@@ -61,8 +62,8 @@ export default (props) => {
                       style={{ height: 400 }}
                       className="ct-series-g ct-major-tent"
                     >
-                      <ResponsiveScatterPlot
-                        colors={{ scheme: "accent" }}
+                      <ResponsiveLine
+                        colors={{ scheme: "category10" }}
                         data={p_data.chart_data}
                         margin={{ top: 60, right: 140, bottom: 70, left: 90 }}
                         xScale={{ type: "linear", min: "auto", max: "auto" }}
@@ -83,7 +84,8 @@ export default (props) => {
                           tickRotation: 90,
                           legend: p_data.x_axis,
                           legendPosition: "middle",
-                          format: (value) => value.toExponential(2),
+                          // format: (value) => value,
+                          format: (value) => value < 0.001 || value > 10000 ? value.toExponential(2) : value,
                           legendOffset: 60,
                         }}
                         axisLeft={{

probe_ably/service/src/index.js → probe_ably/app/src/index.js

@@ -22,6 +22,7 @@ import HomePage from "./pages/HomePage";
 // core styles
 import "./scss/volt.scss";
 
+
 ReactDOM.render(
   <div>
     {/* <ScrollToTop /> */}

probe_ably/app/src/pages/HomePage.js

@@ -0,0 +1,57 @@
+import {
+  Col, Container,
+  Navbar,
+  Row,
+  Spinner,
+  Card,
+} from "@themesberg/react-bootstrap";
+
+import React, { useEffect, useState } from "react";
+import Report from "./dashboard/Report.js"
+import ConfigDashboard from "./forms/ConfigDashboard";
+
+export default () => {
+  const [isProbing, setIsProbing] = useState(false); 
+  const [results, setResults] = useState(null);
+	const [taskProgress, setTaskProgress] = useState(0);
+	const [modelProgress, setModelProgress] = useState(0);
+	const [probesProgress, setProbesProgress] = useState(0);
+
+
+  const startProbing = async (formData) => {
+    setIsProbing(true);
+    await fetch("/start_probing", {method: "POST", body: formData})
+    .then(response => response.json())
+    .then(data => setResults(data));
+    setIsProbing(false);
+  }
+
+  return (
+    <div>
+    <Navbar
+    variant="dark"
+    expand="lg"
+    bg="dark"
+    className="navbar-transparent navbar-theme-primary my-2"
+    >
+      <Container>
+        <Navbar.Brand href="#" className="me-md-3" style={{ padding: 5 }}>
+          Probe_Ably
+        </Navbar.Brand>
+      </Container>
+    </Navbar>
+    <main style={{ padding: 21 }}>
+    <ConfigDashboard startProbing={startProbing}/>
+      <Report taskProgress={taskProgress} 
+        modelProgress={modelProgress} 
+        probesProgress={probesProgress} 
+        setTaskProgress={setTaskProgress}
+        setModelProgress={setModelProgress}
+        setProbesProgress={setProbesProgress}
+        results={results}
+        isProbing={isProbing}>
+      </Report>
+    </main>
+    </div>
+    )
+  };