[feat] Create a Dashboard page to provide a better onboarding experience

CHANGELOG.md

@@ -13,6 +13,7 @@
 - Add command for dangling params cleanup (mihran113)
 - Deprecate Python 3.6 (alberttorosyan)
 - Add MXNet integration (tmynn)
+- Create a Dashboard page to provide a better onboarding experience (arsengit, roubkar, KaroMourad, mihran113)
 
 ### Fixes:
 

aim/sdk/remote_repo_proxy.py

@@ -27,3 +27,6 @@ def __init__(self, client: 'Client'):
 
     def list_all_runs(self):
         return self._rpc_client.run_instruction(-1, self._handler, 'list_all_runs', [])
+
+    def list_active_runs(self):
+        return self._rpc_client.run_instruction(-1, self._handler, 'list_active_runs', [])

aim/sdk/repo.py

@@ -448,6 +448,20 @@ def _all_run_hashes(self) -> Set[str]:
     def list_all_runs(self) -> List[str]:
         return list(self._all_run_hashes())
 
+    def _active_run_hashes(self) -> Set[str]:
+        if self.is_remote_repo:
+            remote_repo = RemoteRepoProxy(self._client)
+            return set(remote_repo.list_active_runs())
+        else:
+            chunks_dir = os.path.join(self.path, 'meta', 'progress')
+            if os.path.exists(chunks_dir):
+                return set(os.listdir(chunks_dir))
+            else:
+                return set()
+
+    def list_active_runs(self) -> List[str]:
+        return list(self._active_run_hashes())
+
     def total_runs_count(self) -> int:
         db = self.structured_db
         if db:

aim/sdk/run.py

@@ -638,7 +638,11 @@ def _get_sequence(
         sequence = seq_cls(sequence_name, context, self)
         return sequence if bool(sequence) else None
 
-    def collect_sequence_info(self, sequence_types: Tuple[str, ...], skip_last_value=False) -> Dict[str, list]:
+    def collect_sequence_info(
+            self,
+            sequence_types: Union[str, Tuple[str, ...]],
+            skip_last_value=False
+    ) -> Dict[str, list]:
         """Retrieve Run's all sequences general overview.
 
         Args:

aim/web/api/dashboards/pydantic_models.py

@@ -10,6 +10,7 @@ class DashboardOut(BaseModel):
     name: str
     description: str = None
     app_id: Optional[UUID] = None
+    app_type: Optional[str] = None
     updated_at: datetime = 'Wed, 01 Jan 2021 16:12:07 GMT'
     created_at: datetime = 'Wed, 01 Jan 2021 16:12:07 GMT'
 

aim/web/api/dashboards/serializers.py

@@ -15,6 +15,7 @@ def dashboard_response_serializer(dashboard_object, session):
         'name': dashboard_object.name,
         'description': dashboard_object.description,
         'app_id': app.uuid if app else None,
+        'app_type': app.type if app else None,
         'updated_at': dashboard_object.updated_at,
         'created_at': dashboard_object.created_at
     }

aim/web/api/projects/pydantic_models.py

@@ -10,7 +10,7 @@ class ProjectApiOut(BaseModel):
 
 
 class ProjectParamsOut(BaseModel):
-    params: Dict
+    params: Optional[Dict] = None
     metric: Optional[Dict[str, list]] = None
     images: Optional[Dict[str, list]] = None
     texts: Optional[Dict[str, list]] = None
@@ -22,6 +22,8 @@ class ProjectParamsOut(BaseModel):
 class ProjectActivityApiOut(BaseModel):
     num_experiments: int
     num_runs: int
+    num_archived_runs: int
+    num_active_runs: int
     activity_map: Dict[str, int] = {"2021-01-01": 54}
 
 

aim/web/api/projects/views.py

@@ -46,15 +46,20 @@ async def project_activity_api(x_timezone_offset: int = Header(default=0),
         raise HTTPException(status_code=404)
 
     num_runs = 0
+    num_archived_runs = 0
     activity_counter = Counter()
     for run in factory.runs():
         creation_time = run.created_at - timedelta(minutes=x_timezone_offset)
         activity_counter[creation_time.strftime('%Y-%m-%dT%H:00:00')] += 1
         num_runs += 1
+        if run.archived:
+            num_archived_runs += 1
 
     return {
         'num_experiments': len(factory.experiments()),
         'num_runs': num_runs,
+        'num_archived_runs': num_archived_runs,
+        'num_active_runs': len(project.repo.list_active_runs()),
         'activity_map': dict(activity_counter),
     }
 
@@ -118,7 +123,8 @@ async def update_pinned_metrics_api(request_data: ProjectPinnedSequencesApiIn):
 
 
 @projects_router.get('/params/', response_model=ProjectParamsOut, response_model_exclude_defaults=True)
-async def project_params_api(sequence: Optional[Tuple[str, ...]] = Query(())):
+async def project_params_api(sequence: Optional[Tuple[str, ...]] = Query(()),
+                             exclude_params: Optional[bool] = False):
     project = Project()
 
     if not project.exists():
@@ -131,10 +137,12 @@ async def project_params_api(sequence: Optional[Tuple[str, ...]] = Query(())):
             raise HTTPException(status_code=400, detail=str(e))
     else:
         sequence = project.repo.available_sequence_types()
-
-    response = {
-        'params': project.repo.collect_params_info(),
-    }
+    if exclude_params:
+        response = {}
+    else:
+        response = {
+            'params': project.repo.collect_params_info(),
+        }
     response.update(**project.repo.collect_sequence_info(sequence))
     return response
 

aim/web/api/runs/pydantic_models.py

@@ -84,14 +84,19 @@ class RunInfoOut(BaseModel):
 
 
 class RunSearchRunView(BaseModel):
-    params: dict
-    traces: List[TraceOverview]
+    params: Optional[dict]
+    traces: Optional[List[TraceOverview]]
     props: PropsView
 
 
 RunSearchApiOut = Dict[str, RunSearchRunView]
 
 
+class RunActiveOut(BaseModel):
+    traces: Dict[str, List[TraceOverview]]
+    props: PropsView
+
+
 # request models
 class AlignedTraceIn(BaseModel):
     context: dict

aim/web/api/runs/utils.py

@@ -227,7 +227,9 @@ async def metric_search_result_streamer(traces: SequenceCollection,
 async def run_search_result_streamer(runs: SequenceCollection,
                                      limit: int,
                                      skip_system: bool,
-                                     report_progress: Optional[bool] = True) -> bytes:
+                                     report_progress: Optional[bool] = True,
+                                     exclude_params: Optional[bool] = False,
+                                     exclude_traces: Optional[bool] = False) -> bytes:
     try:
         run_count = 0
         last_reported_progress_time = time.time()
@@ -247,11 +249,13 @@ async def run_search_result_streamer(runs: SequenceCollection,
             run = run_trace_collection.run
             run_dict = {
                 run.hash: {
-                    'params': get_run_params(run, skip_system=skip_system),
-                    'traces': run.collect_sequence_info(sequence_types='metric'),
                     'props': get_run_props(run)
                 }
             }
+            if not exclude_params:
+                run_dict[run.hash]['params'] = get_run_params(run, skip_system=skip_system)
+            if not exclude_traces:
+                run_dict[run.hash]['traces'] = run.collect_sequence_info(sequence_types='metric')
 
             encoded_tree = encode_tree(run_dict)
             yield collect_streamable_data(encoded_tree)
@@ -269,6 +273,36 @@ async def run_search_result_streamer(runs: SequenceCollection,
         pass
 
 
+async def run_active_result_streamer(repo: 'Repo', report_progress: Optional[bool] = True):
+    try:
+        active_run_hashes = repo.list_active_runs()
+
+        active_runs_count = len(active_run_hashes)
+        progress_reports_sent = 0
+
+        for run_hash in active_run_hashes:
+            await asyncio.sleep(ASYNC_SLEEP_INTERVAL)
+
+            run = Run(run_hash, repo=repo, read_only=True)
+            run_dict = {
+                run.hash: {
+                    'props': get_run_props(run),
+                    'traces': run.collect_sequence_info(sequence_types='metric')
+                }
+            }
+
+            encoded_tree = encode_tree(run_dict)
+            yield collect_streamable_data(encoded_tree)
+
+            if report_progress:
+                yield collect_streamable_data(encode_tree(
+                    {f'progress_{progress_reports_sent}': (progress_reports_sent + 1, active_runs_count)}
+                ))
+                progress_reports_sent += 1
+    except asyncio.CancelledError:
+        pass
+
+
 def collect_requested_metric_traces(run: Run, requested_traces: List[TraceBase], steps_num: int = 200) -> List[dict]:
     processed_traces_list = []
     for requested_trace in requested_traces:

aim/web/api/runs/views.py

@@ -22,13 +22,15 @@
     get_run_params,
     get_run_props,
     metric_search_result_streamer,
+    run_active_result_streamer,
     run_search_result_streamer,
     run_logs_streamer
 
 )
 from aim.web.api.runs.pydantic_models import (
     MetricAlignApiIn,
     QuerySyntaxErrorOut,
+    RunActiveOut,
     RunTracesBatchApiIn,
     RunMetricCustomAlignApiOut,
     RunMetricSearchApiOut,
@@ -59,6 +61,8 @@ async def run_search_api(q: Optional[str] = '',
                          offset: Optional[str] = None,
                          skip_system: Optional[bool] = True,
                          report_progress: Optional[bool] = True,
+                         exclude_params: Optional[bool] = False,
+                         exclude_traces: Optional[bool] = False,
                          x_timezone_offset: int = Header(default=0),):
     from aim.sdk.sequence_collection import QueryRunSequenceCollection
     repo = get_project_repo()
@@ -72,7 +76,9 @@ async def run_search_api(q: Optional[str] = '',
                                       report_mode=QueryReportMode.PROGRESS_TUPLE,
                                       timezone_offset=x_timezone_offset)
 
-    streamer = run_search_result_streamer(runs, limit, skip_system, report_progress)
+    streamer = run_search_result_streamer(runs, limit,
+                                          skip_system, report_progress,
+                                          exclude_params, exclude_traces)
     return StreamingResponse(streamer)
 
 
@@ -116,6 +122,16 @@ async def run_metric_search_api(q: Optional[str] = '',
     return StreamingResponse(streamer)
 
 
+@runs_router.get('/active/', response_model=RunActiveOut)
+async def get_active_runs_api(report_progress: Optional[bool] = True):
+    repo = get_project_repo()
+    repo._prepare_runs_cache()
+
+    streamer = run_active_result_streamer(repo)
+
+    return StreamingResponse(streamer)
+
+
 @runs_router.get('/{run_id}/info/', response_model=RunInfoOut)
 async def run_params_api(run_id: str,
                          skip_system: Optional[bool] = False,

aim/web/ui/package.json

@@ -8,6 +8,7 @@
     "@material-ui/icons": "^4.11.2",
     "@material-ui/lab": "^4.0.0-alpha.60",
     "@monaco-editor/react": "4.4.4",
+    "@types/marked": "^4.0.7",
     "@uiw/react-textarea-code-editor": "^1.4.14",
     "bs58check": "^2.1.2",
     "classnames": "^2.3.1",
@@ -20,6 +21,7 @@
     "highcharts-react-official": "^3.1.0",
     "humanize-duration": "^3.27.0",
     "lodash-es": "^4.17.21",
+    "marked": "^4.1.1",
     "material-ui-audio-player": "^1.7.1",
     "md5": "^2.3.0",
     "memoize-one": "^5.2.1",