Skip to content

Commit a433b0f

Browse files
authored
CTA for leap-bundle (#3)
* CAT in readme * CTA end of log
1 parent abc9ee5 commit a433b0f

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ It uses Ray Train + Accelerate for distributed training.
5454

5555
Unless you overwrote `output_dir`, results will be stored in `outputs/training_type/job_name/`
5656

57+
### 3. Bundle Checkpoint for LEAP
58+
59+
When training is done, you can bundle your output checkpoint with `leap-bundle` to use it directly within LEAP. Checkout our [Quick Start guide](https://leap.liquid.ai/docs/leap-bundle/quick-start?utm_source=github&utm_medium=link&utm_campaign=LEAP&utm_content=general).
60+
5761
## 🧪 Advanced Configuration
5862

5963
### Default Configs Location and Adding New Configs

src/leap_finetune/trainer.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
from ray.train import RunConfig, ScalingConfig
66
from ray.runtime_env import RuntimeEnv
77
from ray.train.torch import TorchTrainer
8+
from rich.console import Console
9+
from rich.panel import Panel
810
from torch import cuda
911

1012
from leap_finetune.utils.constants import RUNTIME_DIR
@@ -70,3 +72,25 @@ def ray_trainer(job_config: dict) -> None:
7072
)
7173

7274
trainer.fit()
75+
76+
console = Console()
77+
quick_start_url = (
78+
"https://leap.liquid.ai/docs/leap-bundle/quick-start?utm_source=github"
79+
"&utm_medium=link&utm_campaign=LEAP&utm_content=general"
80+
)
81+
82+
cta_message = (
83+
"[bold green]Training complete![/bold green]\n\n"
84+
f"[bold]Checkpoint directory:[/bold] [cyan]{output_dir}[/cyan]\n\n"
85+
"Bundle your output checkpoint with [bold]leap-bundle[/bold] to use it in LEAP:\n"
86+
f"[dim]leap-bundle create {output_dir}[/dim]\n\n"
87+
f"Quick Start: [link={quick_start_url}]{quick_start_url}[/link]"
88+
)
89+
90+
console.print(
91+
Panel.fit(
92+
cta_message,
93+
title="Next Step: Bundle for LEAP",
94+
border_style="green",
95+
)
96+
)

0 commit comments

Comments
 (0)