Skip to content

🎨 Palette: Helpful Tooltips for Abstract Inputs #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aarjava wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🎨 Palette: Helpful Tooltips for Abstract Inputs #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .Jules/palette.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## 2024-04-04 - Helpful Tooltips for Abstract Inputs
**Learning:** Inputs involving statistical or financial parameters (like quantiles or basis points) can be abstract and confusing. Providing concrete examples in tooltips significantly improves usability and ensures users understand the scale and meaning of their inputs.
**Action:** Always include concrete, numerical examples in `help` tooltips for statistical, financial, or unit-based inputs (e.g., "10 bps = 0.10%").
14 changes: 12 additions & 2 deletions src/dashboard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,22 @@ def get_cache_key(*args) -> str:
st.info("Using full-sample quantiles (exploratory mode)")

vol_q_high = st.slider(
"High Volatility Quantile", 0.5, 0.95, DEFAULT_VOL_QUANTILE_HIGH, 0.05
"High Volatility Quantile",
0.5,
0.95,
DEFAULT_VOL_QUANTILE_HIGH,
0.05,
help="Example: 0.90 means the top 10% of volatility values are considered 'High'.",
)

if mode == "Single-Asset":
st.subheader("5. Backtest Settings")
bt_cost = st.number_input("Transaction Cost (bps)", value=DEFAULT_COST_BPS, step=1) / 10000
bt_cost = (
st.number_input(
"Transaction Cost (bps)", value=DEFAULT_COST_BPS, step=1, help="10 bps = 0.10%"
)
/ 10000
)
allow_short = st.checkbox("Allow Short Selling?", value=False)
else:
st.subheader("5. Alert Thresholds")
Expand Down
Loading