Overview

π§ Purpose¶
The Sake user guide provides the operating instructions for the applicationβs end-to-end analytics workflow: install the environment, load budget execution data, inspect data quality, run descriptive and inferential statistics, engineer model-ready features, train classification and regression models, and review visualization outputs.
Sake is designed around a conventional analytical workflow. It starts with source data, validates that data, transforms it into an analysis-ready form, applies statistical or machine-learning methods, and then presents outputs that can be reviewed, compared, and explained.
π§± Workflow Overview¶
| Stage | User Activity | Output |
|---|---|---|
| Installation | Prepare Python, dependencies, and runtime environment. | Working local environment or notebook runtime. |
| Data Loading | Load CSV, Excel, File A Account Balances, or DataFrame inputs. | Initial analytical dataset. |
| Data Overview | Review shape, schema, missing values, and distributions. | Data quality profile. |
| Descriptive Statistics | Summarize central tendency, spread, skew, and outliers. | Statistical baseline. |
| Inferential Statistics | Test relationships, differences, and significance. | Evidence for relationships or group differences. |
| Feature Engineering | Prepare numeric, categorical, and reduced-dimension features. | Model-ready feature matrix. |
| Classification | Train and evaluate categorical prediction models. | Classification metrics and diagnostics. |
| Regression | Train and evaluate numeric prediction models. | Regression metrics and diagnostics. |
| Visualization | Review charts and diagnostics. | Interpretable analytical outputs. |
| Streamlit App | Run the interactive application. | Browser-based analysis workflow. |
π Recommended Sequence¶
Use this sequence for a complete analysis cycle:
- Install dependencies.
- Launch the Streamlit application or notebook.
- Load the dataset.
- Confirm the schema and data types.
- Review missing values and outliers.
- Run descriptive statistics.
- Run inferential statistics when group comparisons or relationships matter.
- Engineer features for machine learning.
- Train classification or regression models.
- Compare model metrics and diagnostic plots.
- Document assumptions, limitations, and validation results.
ποΈ Budget Execution Context¶
Sake is especially useful for budget execution analytics where the data contains Treasury Account Symbol structure, budgetary resources, obligations, outlays, recoveries, balances, or account classifications. The same workflow can also support general tabular machine-learning datasets when the target and features are clearly defined.
β Minimum Inputs¶
At minimum, an analysis-ready dataset should include:
| Requirement | Description |
|---|---|
| Rows | Observations, accounts, reporting periods, or records. |
| Columns | Numeric and categorical variables available for analysis. |
| Target variable | Required for supervised classification or regression. |
| Metadata | Optional fields such as account code, agency, period, classification, or availability. |
π§ͺ Common Use Cases¶
| Use Case | Description |
|---|---|
| Account balance profiling | Review distributions, missing values, and high-risk accounts. |
| Budget execution analysis | Compare obligations, outlays, resources, and balances. |
| Model benchmarking | Compare multiple algorithms against common metrics. |
| Feature exploration | Test whether transformations or dimensionality reduction improve results. |
| Teaching and prototyping | Demonstrate classical statistics, machine learning, and diagnostics. |
π Related Pages¶
| Page | Use |
|---|---|
| Installation | Prepare the runtime environment. |
| Data Loading | Load CSV, Excel, and DataFrame inputs. |
| Data Overview | Inspect data quality and structure. |
| Feature Engineering | Prepare model-ready features. |
| Classification | Train categorical prediction models. |
| Regression | Train numeric prediction models. |
| Visualization | Interpret plots and diagnostics. |
| Streamlit App | Use the browser interface. |