guidepost 0.2.4__tar.gz → 0.2.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: guidepost
3
- Version: 0.2.4
3
+ Version: 0.2.6
4
4
  Summary: Guidepost. An overview visualization for understanding supercomputer queue data.
5
5
  Home-page: https://github.com/cscully-allison/guidepost
6
6
  Author: Connor Scully-Allison
@@ -78,7 +78,8 @@ gp.vis_configs = {
78
78
  'y': 'start_time',
79
79
  'color': 'nodes_req',
80
80
  'color_agg': 'avg',
81
- 'categorical': 'user'
81
+ 'categorical': 'user',
82
+ 'facet_by': 'partition'
82
83
  }
83
84
  ```
84
85
 
@@ -101,11 +102,8 @@ Below is an example of the kind of data Guidepost works with:
101
102
 
102
103
  | Job ID | Runtime (hours) | Nodes Used | partition | Status |
103
104
  |--------|-----------------|------------|-----------|--------|
104
- | 12345 | 5.2 | 10 | short | Complete |
105
- | 12346 | 12.0 | 20 | long | Running |
106
-
107
-
108
- Note that a column named "partition" must be sepecified.
105
+ | 12345 | 5.2 | 10 | short | Complete |
106
+ | 12346 | 12.0 | 20 | long | Running |
109
107
 
110
108
  ---
111
109
 
@@ -123,7 +121,8 @@ Vis configurations must be specified as a python dictonary with the following fi
123
121
  - '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.
124
122
  - '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.
125
123
  - 'color_agg': This is a specification for what aggregation is used for the color variable. It can be: 'avg', 'variance', 'std', 'sum', or 'median'
126
- - 'categorical': A categorical variable from the dataset. It must be a string. The visualization will show the top 7 instances of this variable.
124
+ - '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.
125
+ - 'facet_by': A categorical variable from the dataset. Automatically looks for 'queue' or 'partition' if this config is not specified.
127
126
 
128
127
 
129
128
 
@@ -50,7 +50,8 @@ gp.vis_configs = {
50
50
  'y': 'start_time',
51
51
  'color': 'nodes_req',
52
52
  'color_agg': 'avg',
53
- 'categorical': 'user'
53
+ 'categorical': 'user',
54
+ 'facet_by': 'partition'
54
55
  }
55
56
  ```
56
57
 
@@ -73,11 +74,8 @@ Below is an example of the kind of data Guidepost works with:
73
74
 
74
75
  | Job ID | Runtime (hours) | Nodes Used | partition | Status |
75
76
  |--------|-----------------|------------|-----------|--------|
76
- | 12345 | 5.2 | 10 | short | Complete |
77
- | 12346 | 12.0 | 20 | long | Running |
78
-
79
-
80
- Note that a column named "partition" must be sepecified.
77
+ | 12345 | 5.2 | 10 | short | Complete |
78
+ | 12346 | 12.0 | 20 | long | Running |
81
79
 
82
80
  ---
83
81
 
@@ -95,7 +93,8 @@ Vis configurations must be specified as a python dictonary with the following fi
95
93
  - '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.
96
94
  - '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.
97
95
  - 'color_agg': This is a specification for what aggregation is used for the color variable. It can be: 'avg', 'variance', 'std', 'sum', or 'median'
98
- - 'categorical': A categorical variable from the dataset. It must be a string. The visualization will show the top 7 instances of this variable.
96
+ - '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.
97
+ - 'facet_by': A categorical variable from the dataset. Automatically looks for 'queue' or 'partition' if this config is not specified.
99
98
 
100
99
 
101
100