guidepost 0.2.3__tar.gz → 0.2.5__tar.gz

{guidepost-0.2.3 → guidepost-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: guidepost
-Version: 0.2.3
+Version: 0.2.5
 Summary: Guidepost. An overview visualization for understanding supercomputer queue data.
 Home-page: https://github.com/cscully-allison/guidepost
 Author: Connor Scully-Allison
@@ -78,7 +78,8 @@ gp.vis_configs = {
         'y': 'start_time',
         'color': 'nodes_req',
         'color_agg': 'avg',
-        'categorical': 'user'
+        'categorical': 'user',
+        'facet_by': 'partition'
 }
 ```
 
@@ -101,11 +102,8 @@ Below is an example of the kind of data Guidepost works with:
 
 | Job ID | Runtime (hours) | Nodes Used | partition | Status |
 |--------|-----------------|------------|-----------|--------|
-| 12345  | 5.2             | 10         | short | Complete |
-| 12346  | 12.0            | 20         | long  | Running  |
-
-
-Note that a column named "partition" must be sepecified.
+| 12345  | 5.2             | 10         | short | Complete   |
+| 12346  | 12.0            | 20         | long  | Running    |
 
 ---
 
@@ -123,7 +121,8 @@ Vis configurations must be specified as a python dictonary with the following fi
 - 'y': The column from the pandas dataframe which will be shown on the y axis of this visualization. This can be an integer or float.
 - 'color': The column from the pandas dataframe which will determine the color of squares in the main summary view. This can be an integer or float.
 - 'color_agg': This is a specification for what aggregation is used for the color variable. It can be: 'avg', 'variance', 'std', 'sum', or 'median'
-- 'categorical': A categorical variable from the dataset. It must be a string. The visualization will show the top 7 instances of this variable. 
+- 'categorical': A categorical variable from the dataset. The data column must be a string datatype. The visualization will show the top 10 instances of this variable.
+- 'facet_by': A categorical variable from the dataset. Automatically looks for 'queue' or 'partition' if this config is not specified.
 
 
 

{guidepost-0.2.3 → guidepost-0.2.5}/README.md

@@ -50,7 +50,8 @@ gp.vis_configs = {
         'y': 'start_time',
         'color': 'nodes_req',
         'color_agg': 'avg',
-        'categorical': 'user'
+        'categorical': 'user',
+        'facet_by': 'partition'
 }
 ```
 
@@ -73,11 +74,8 @@ Below is an example of the kind of data Guidepost works with:
 
 | Job ID | Runtime (hours) | Nodes Used | partition | Status |
 |--------|-----------------|------------|-----------|--------|
-| 12345  | 5.2             | 10         | short | Complete |
-| 12346  | 12.0            | 20         | long  | Running  |
-
-
-Note that a column named "partition" must be sepecified.
+| 12345  | 5.2             | 10         | short | Complete   |
+| 12346  | 12.0            | 20         | long  | Running    |
 
 ---
 
@@ -95,7 +93,8 @@ Vis configurations must be specified as a python dictonary with the following fi
 - 'y': The column from the pandas dataframe which will be shown on the y axis of this visualization. This can be an integer or float.
 - 'color': The column from the pandas dataframe which will determine the color of squares in the main summary view. This can be an integer or float.
 - 'color_agg': This is a specification for what aggregation is used for the color variable. It can be: 'avg', 'variance', 'std', 'sum', or 'median'
-- 'categorical': A categorical variable from the dataset. It must be a string. The visualization will show the top 7 instances of this variable. 
+- 'categorical': A categorical variable from the dataset. The data column must be a string datatype. The visualization will show the top 10 instances of this variable.
+- 'facet_by': A categorical variable from the dataset. Automatically looks for 'queue' or 'partition' if this config is not specified.