Skip to content

Commit 1065639

Browse files
committed
doc: table for highlights
1 parent f0bc0fe commit 1065639

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

README.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# CodeFlare Desktop Client
77

88
<p align="center">
9-
<img src="./images/codeflare_cli.svg" width="100" height="100" align="left">
9+
<img src="./images/codeflare_cli.svg" width="110" height="110" align="left">
1010
</p>
1111

1212
[CodeFlare](https://codeflare.dev) is a framework to simplify the
@@ -17,28 +17,10 @@ This repository is home to the open source CodeFlare CLI,
1717
`codeflare`. On macOS, you can [get started
1818
immediately](#installation) using `brew install`.
1919

20-
## Highlights
21-
22-
- **Easy job submission against Kubernetes**: `codeflare` guides you
23-
through the complex process by posing a series of questions (where
24-
is your source code? where is your data?). `codeflare` has the
25-
smarts to glue all of these answers together, culminating in a
26-
running job.
27-
28-
- **Optimized Inner Loop**: You may give a name to the set of answers
29-
you provided. We call this a "profile". Your inner loop of jobs
30-
submission can thus be optimized by running `codeflare -y -p <profileName>` (the `-y` meaning auto-answer "yes" to accept all
31-
prior answers). This also allows you to switch quickly between
32-
profiles, and even submit jobs to distinct profiles concurrently.
33-
34-
- **Pop-up Graphical dashboards with a few keystrokes or clicks**:
35-
`codeflare` leverages the power of
36-
[Kui](https://github.com/kubernetes-sigs/kui) to offer you quick
37-
access to a variety of graphical dashboards, including MLFlow,
38-
Tensorboard, and a custom CodeFlare Dashboard that helps you track
39-
the progress of an individual job. There is no need to fiddle with
40-
yaml files and port forwards. With a few clicks, you will get a
41-
popup window that shows you the chosen dashboard.
20+
| **Rapid Job Submission** | **Optimized Inner Loop** | **Easy access to Pop-up Dashboards** |
21+
| ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22+
| `codeflare` guides you through the complex process by posing a series of questions. Where is your source code? Where is your data? | You may name the set of answers you provided. We call this a **profile**. Your inner loop then becomes: `codeflare -y -p <profileName>`. The `-y` means accept all prior answers. | `codeflare` offers quick access to a variety of graphical dashboards, including MLFlow, Tensorboard, and a custom CodeFlare Dashboard that helps you track the progress of an individual job. |
23+
| `codeflare` glues answers together and submits a Kubernetes job. | You can switch quickly between profiles, and even submit jobs to distinct profiles concurrently. | There is no need to fiddle with yaml files and port forwards. With a few clicks, you will get a popup dashboard window. |
4224

4325
## Installation
4426

0 commit comments

Comments
 (0)