From 2fd97ba48000f0a589f68e0dad8f5a415d0ab40a Mon Sep 17 00:00:00 2001 From: Mykhailo Bobrovskyi Date: Fri, 17 Jan 2025 09:10:34 +0200 Subject: [PATCH] Update descriptions. (#41) --- README.md | 7 +++++-- docs/_index.md | 5 ++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6dfbfd5..5cfc5af 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # kjob -KJob: Tool for CLI-loving ML researchers +Run AI/ML jobs based on the pre-defined templates ## Description -The `kubectl-kjob` plugin, `kjobctl`, allows you to list, describe and create jobs. +This kubectl plugin allows ML researchers to run templated Jobs with different values +for the application-specific parameters, without the need to edit and submit entire +YAML files. The tool comes with built-in support for running slurm scripts inside +a Kubernetes cluster. Read the [overview](docs/_index.md) to learn more. diff --git a/docs/_index.md b/docs/_index.md index b45f998..9954c96 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -1,6 +1,9 @@ # Kubectl Kjob Plugin -The `kubectl-kjob` plugin, `kjobctl`, allows you to list, describe and create jobs. +This kubectl plugin allows ML researchers to run templated Jobs with different values +for the application-specific parameters, without the need to edit and submit entire +YAML files. The tool comes with built-in support for running slurm scripts inside +a Kubernetes cluster. ## Syntax