diff --git a/README.md b/README.md index ceea9d4dee..4a1f8d1e03 100644 --- a/README.md +++ b/README.md @@ -210,13 +210,13 @@ For an overview of the full workflow, see the [workflow diagram](./docs/workflow --help Show this message and exit. Commands: - config Command group for interacting with the config of InstructLab. - data Command group for interacting with the data generated by... - model Command group for interacting with the models in InstructLab. - process Command group for interacting with the processes run by... - rag Command group for interacting with the RAG for InstructLab. - system Command group for all system-related command calls. - taxonomy Command group for interacting with the taxonomy of InstructLab. + config Manage InstructLab configuration. + data Generate synthetic data. + model Manage GenAI (LLM) models. + process Manage running processes. + rag Retrieval-Augmented Generation (RAG). + system Execute system commands. + taxonomy Manage taxonomy datasets. Aliases: chat model chat diff --git a/src/instructlab/cli/data/data.py b/src/instructlab/cli/data/data.py index 1421324fc4..979004e519 100644 --- a/src/instructlab/cli/data/data.py +++ b/src/instructlab/cli/data/data.py @@ -16,7 +16,7 @@ ) @click.pass_context def data(ctx): - """Command group for interacting with the data generated by InstructLab. + """Generate synthetic data. If this is your first time running ilab, it's best to start with `ilab config init` to create the environment. """ diff --git a/src/instructlab/cli/process/process.py b/src/instructlab/cli/process/process.py index 921a999788..080977421e 100644 --- a/src/instructlab/cli/process/process.py +++ b/src/instructlab/cli/process/process.py @@ -16,7 +16,7 @@ ) @click.pass_context def process(ctx): - """Command group for interacting with the processes run by InstructLab. + """Manage running processes. If this is your first time running ilab, it's best to start with `ilab config init` to create the environment. """ diff --git a/src/instructlab/cli/rag/rag.py b/src/instructlab/cli/rag/rag.py index 4d823d3ba9..48187df2a6 100644 --- a/src/instructlab/cli/rag/rag.py +++ b/src/instructlab/cli/rag/rag.py @@ -16,7 +16,7 @@ @click.pass_context @clickext.display_params def rag(ctx): - """Command group for interacting with the RAG for InstructLab. + """Retrieval-Augmented Generation (RAG). If this is your first time running ilab, it's best to start with `ilab config init` to create the environment. """ diff --git a/src/instructlab/cli/system/system.py b/src/instructlab/cli/system/system.py index a92d1e6fdd..ffcaa84786 100644 --- a/src/instructlab/cli/system/system.py +++ b/src/instructlab/cli/system/system.py @@ -18,6 +18,6 @@ ) @click.pass_context def system(ctx): - """Command group for all system-related command calls.""" + """Execute system commands.""" ctx.obj = ctx.parent.obj ctx.default_map = ctx.parent.default_map diff --git a/src/instructlab/config/config.py b/src/instructlab/config/config.py index f22af200b1..0b735c19cd 100644 --- a/src/instructlab/config/config.py +++ b/src/instructlab/config/config.py @@ -15,7 +15,7 @@ ) @click.pass_context def config(ctx): - """Command group for interacting with the config of InstructLab. + """Manage InstructLab configuration. If this is your first time running ilab, it's best to start with `ilab config init` to create the environment. """ diff --git a/src/instructlab/model/model.py b/src/instructlab/model/model.py index 1f36578b6e..03989f316f 100644 --- a/src/instructlab/model/model.py +++ b/src/instructlab/model/model.py @@ -18,7 +18,7 @@ @click.pass_context # pylint: disable=redefined-outer-name def model(ctx): - """Command group for interacting with the models in InstructLab. + """Manage GenAI (LLM) models. If this is your first time running ilab, it's best to start with `ilab config init` to create the environment. """ diff --git a/src/instructlab/taxonomy/taxonomy.py b/src/instructlab/taxonomy/taxonomy.py index 5bfb341207..e516223e55 100644 --- a/src/instructlab/taxonomy/taxonomy.py +++ b/src/instructlab/taxonomy/taxonomy.py @@ -16,7 +16,7 @@ ) @click.pass_context def taxonomy(ctx): - """Command group for interacting with the taxonomy of InstructLab. + """Manage taxonomy datasets. If this is your first time running ilab, it's best to start with `ilab config init` to create the environment. """