Build a reusable research visualization template#1
Merged
Conversation
WalkthroughThis pull request introduces a complete full-stack research tool template project. The backend adds a FastAPI application with CORS middleware, environment variable loading, and two API endpoints for experiments data under Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.gitignore:
- Around line 14-17: Update the .gitignore entries that currently list
backend/data/*.csv, backend/data/*.jsonl, and backend/data/*.parquet to cover
additional extensions and nested folders: replace or supplement those lines with
broader patterns such as backend/data/* (or backend/data/** for recursive
ignores) and add any specific extensions you need (e.g., .json, .txt, .xlsx) so
all data files and subdirectories under backend/data are excluded; ensure you
keep or remove the original specific patterns as appropriate for your desired
granularity.
- Around line 9-12: Update the Node section of .gitignore to also ignore local
environment variants and common debug/log files: add patterns for .env, .env.*
(including .env.local/.env.development), npm-debug.log, yarn-debug.log,
yarn-error.log, pnpm-debug.log and any .log files generated during development
so local configuration and debug logs (previously only node_modules/, dist/,
.DS_Store) are not accidentally committed; modify the existing Node block in the
file to include these additional patterns.
- Around line 1-7: Update the Python .gitignore entries to include common
build/test artifacts missing from the current list: add patterns such as
.pytest_cache/, build/, dist/, pip-wheel-metadata/, .mypy_cache/, .tox/,
.cache/, .coverage, *.pyc, *.pyo, *.pyd, *.so and env/ (if not already covered)
so that transient test/build files and wheel metadata are ignored alongside the
existing __pycache__/, *.egg-info/, .env, venv/ and .venv/ entries.
In `@backend/main.py`:
- Line 16: The ALLOWED_ORIGINS parsing uses raw .split(",") which leaves
whitespace and empty entries that can break CORS matching; update the
initialization of allowed_origins so each origin is stripped and empty strings
removed (e.g., build allowed_origins by splitting the env var, calling .strip()
on each entry, and filtering out falsy/empty results) and ensure the cleaned
allowed_origins list is used for CORS registration in the same module
(reference: allowed_origins variable in backend/main.py).
In `@backend/routers/experiments.py`:
- Around line 152-157: The comprehension that builds matching uses direct
equality between _get_config_value(e, x_param) and x_val which is fragile for
floating-point data in EXPERIMENTS; change the comparison to an approximate
check (e.g., math.isclose with a small rel/abs tolerance) or apply a
bucketing/rounding strategy (round to a fixed precision) when comparing values
for x_param and y_param so near-equal floats match reliably; update the list
comprehension building matching and any other comparisons that call
_get_config_value to use the chosen tolerance/rounding approach.
- Around line 115-116: The current filter uses min_accuracy against
e.metrics.accuracy (training accuracy) but the frontend displays bestAcc from
metrics.val_accuracy; update the filter in experiments.py so that when
min_accuracy is provided you filter on e.metrics.val_accuracy instead (i.e.,
change the list comprehension that references e.metrics.accuracy to use
e.metrics.val_accuracy), and also search for any other uses of the min_accuracy
parameter to ensure consistency with the displayed validation metric;
alternatively, if you prefer to keep training accuracy, rename the parameter to
min_train_accuracy across the API and callers (but pick one approach and update
all references such as the results filtering and API parameter/docs).
In `@frontend/src/api/client.ts`:
- Around line 34-38: The fetch call in client.ts can hang; wrap it with an
AbortController and a timeout so stalled requests are aborted and surface a
clear error: create an AbortController, pass controller.signal into
fetch(url.toString(), { signal }), start a setTimeout that calls
controller.abort() after the desired timeout, and clear that timeout after fetch
completes; ensure the error path distinguishes abort/timeouts (e.g., throw a
timeout-specific Error when controller.signal.aborted) and preserve the existing
API error behavior around res and res.ok.
In `@frontend/src/components/charts/Plot.tsx`:
- Around line 14-24: The style prop in the PlotProps interface is typed as
React.CSSProperties but React is not imported, causing a TypeScript error;
update the imports to include the React type or directly import the
CSSProperties type and update PlotProps accordingly (e.g., add an import type
for React or import type { CSSProperties } from "react" and change style?:
React.CSSProperties to style?: CSSProperties) so that the PlotProps interface
(specifically the style property) compiles under strict JSX settings.
In `@frontend/src/components/layout/Sidebar.tsx`:
- Around line 59-62: Replace the hardcoded "localhost:8000" text in the Sidebar
component footer with the app's env-driven API base used by the client: import
or call the existing config/util that exposes the API base (for example
NEXT_PUBLIC_API_BASE, NEXT_PUBLIC_API_URL, or a getApiBase() exported from your
API client module) and render that value inside the <span className="font-mono">
instead of the literal string; include a safe fallback (e.g., "unknown") if the
value is undefined so the UI stays stable.
- Around line 5-9: The NavItem interface references React.ReactNode but React is
not imported; add a type import and update the reference to avoid TS
errors—either import React (e.g., import * as React from 'react') or import the
type directly (import { ReactNode } from 'react') and change the icon property
to use ReactNode; update the NavItem interface declaration (symbol: NavItem,
property: icon) accordingly so the compiler recognizes the type.
In `@frontend/src/components/ui/card.tsx`:
- Around line 31-40: The CardTitle forwarded ref is typed as
HTMLParagraphElement but renders an <h3>; update the React.forwardRef generic to
use HTMLHeadingElement so the ref type matches the rendered element (change the
first generic parameter for CardTitle in the forwardRef call). Ensure the props
generic remains React.HTMLAttributes<HTMLHeadingElement> and keep the same
function signature and ref usage.
In `@frontend/vite.config.ts`:
- Line 9: The alias uses __dirname which breaks in ESM frontend config; replace
__dirname usage when building the "@/": path.resolve(...) alias by deriving the
config directory via import.meta.url and fileURLToPath (from 'url') and then use
path.resolve(configDir, "./src") so alias resolution is ESM-safe; update the
module where alias is defined (the path.resolve call and any imports relying on
__dirname) to use fileURLToPath(import.meta.url) to compute the base directory.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9cbb7336-f26e-4ef9-87ce-c952cf744baa
⛔ Files ignored due to path filters (2)
frontend/package-lock.jsonis excluded by!**/package-lock.jsonuv.lockis excluded by!**/*.lock
📒 Files selected for processing (43)
.gitignore.python-versionAGENTS.mdMakefileREADME.mdbackend/.env.examplebackend/__init__.pybackend/data/.gitkeepbackend/main.pybackend/models/__init__.pybackend/models/experiment.pybackend/routers/__init__.pybackend/routers/experiments.pydocs/agent-prompt-template.mddocs/integrating-into-existing-project.mddocs/integration-smoke-checklist.mdfrontend/index.htmlfrontend/package.jsonfrontend/postcss.config.jsfrontend/src/App.tsxfrontend/src/api/client.tsfrontend/src/api/experiments.tsfrontend/src/components/charts/Plot.tsxfrontend/src/components/layout/Layout.tsxfrontend/src/components/layout/Sidebar.tsxfrontend/src/components/ui/badge.tsxfrontend/src/components/ui/button.tsxfrontend/src/components/ui/card.tsxfrontend/src/components/ui/label.tsxfrontend/src/components/ui/select.tsxfrontend/src/components/ui/separator.tsxfrontend/src/components/ui/slider.tsxfrontend/src/index.cssfrontend/src/lib/utils.tsfrontend/src/main.tsxfrontend/src/pages/HeatmapExplorer.tsxfrontend/src/pages/Overview.tsxfrontend/src/types/experiment.tsfrontend/tailwind.config.jsfrontend/tsconfig.jsonfrontend/tsconfig.node.jsonfrontend/vite.config.tspyproject.toml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
uv+pyproject.tomland keepmakeas the main entrypointWhat Changed
uv sync,uv run,.python-version, anduv.lockAGENTS.md, an integration guide, an agent prompt template, and an integration smoke checklistVerification
uv lockuv syncnpm cimake installuv run python -c "from backend.main import app"make backendcurl http://127.0.0.1:8000/healthnpm run buildDemo