db_query / documentations /parameters_distribution_doc.py
DavMelchi's picture
feat: improve streamlit docs and clean navigation icons
4d0d437
import streamlit as st
st.markdown(
"""
# Parameters Distribution Documentation
## 1. Objective
Explore value distributions of selected parameters in any object class sheet from an OML dump.
## 2. When to use this tool
Use this page for quick parameter profiling, outlier spotting, and baseline checks by object class.
## 3. Input files and accepted formats
- Required: dump file in `.xlsb`
## 4. Required columns/fields
No fixed parameter list is required.
Workflow:
- select object class (sheet)
- select one or multiple parameters (columns)
## 5. Step-by-step usage
1. Open `Apps > Parameters distribution`.
2. Upload dump `.xlsb`.
3. Select object class sheet.
4. Select one or more parameters.
5. Review distribution table and bar chart per parameter.
## 6. Outputs generated
For each selected parameter:
- value count table
- percentage distribution
- bar chart
## 7. Frequent errors and fixes
- Selected sheet appears empty.
- Fix: verify sheet contains readable data rows.
- Parameter list missing expected fields.
- Fix: check selected object class is correct.
- Large cardinality chart is hard to read.
- Fix: filter/clean source data before analysis.
## 8. Minimal reproducible example
- Input: valid `.xlsb` dump.
- Action: select sheet `BTS`, then one categorical parameter.
- Expected result: count/percentage table and bar chart.
## 9. Known limitations
- High-cardinality fields can produce very dense charts.
- No export button in current implementation.
- Requires readable xlsb sheet via current engine.
## 10. Version and update date
- Documentation version: 1.0
- Last update: 2026-02-23
"""
)