annotate README.md @ 1:a92f200d296e draft default tip

planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
author goeckslab
date Fri, 19 Dec 2025 05:12:47 +0000
parents 375c36923da1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
1 # Multimodal Learner (AutoGluon)
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
2
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
3 Train and evaluate AutoGluon’s multimodal models inside Galaxy, combining tabular features with optional text and image columns. The tool targets both classification and regression tasks and outputs reproducible reports and configurations.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
4
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
5 ## Capabilities
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
6 - Ingests CSV/TSV data with a required target column; numeric, categorical, and free-text columns are detected automatically.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
7 - Adds image modality support: supply one or more ZIP archives containing the images referenced in your table, and choose a vision backbone.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
8 - Offers quality presets, time limits, deterministic mode, and cross-validation or custom splits when no external test set is provided.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
9 - Lets you pick text backbones, adjust epochs/learning rate/batch size, and pass additional AutoGluon hyperparameters.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
10 - Handles missing images via configurable strategies and produces transparent metrics plus plots in an interactive HTML report.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
11
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
12 ## Inputs
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
13 - `Training dataset (CSV/TSV)`: includes the label column and any feature columns; image columns should contain file paths that exist in the provided ZIP archives (or absolute paths).
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
14 - Optional `Test dataset (CSV/TSV)`: if omitted, the tool performs train/validation/test splitting or k-fold CV.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
15 - Optional `Image archive(s) (ZIP)`: one or more archives containing the image files referenced in the table.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
16 - Optional overrides: text and image backbones, evaluation metric, quality preset, threshold for binary tasks, and extra hyperparameters (JSON/YAML string or file path).
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
17
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
18 ## Outputs
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
19 - `output_html`: interactive training/evaluation report with metrics and visualizations across the available splits.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
20 - `output_json`: machine-readable summary of metrics (train/val/test or cross-validation folds).
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
21 - `output_config`: YAML config capturing the effective AutoGluon settings used for the run.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
22
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
23 ## Typical Galaxy usage
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
24 1) Upload your training CSV/TSV (and optional test split) plus any ZIP archives that hold referenced images.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
25 2) Select the target/label column, choose text and image backbones as needed, and pick a quality preset or time limit.
a92f200d296e planemo upload for repository https://github.com/goeckslab/gleam.git commit b8a4a5989158b1376c1cb9d630fdeca010ea2a8a
goeckslab
parents: 0
diff changeset
26 3) Run the tool to obtain an HTML report, metrics JSON, and reproducible config for downstream prediction or auditing.