Skip to content

Commit ba2d283

Browse files
authored
Merge pull request #780 from rhatdan/cleanup
Cleanup READMEs and man pages.
2 parents 0d841ec + 8fff12a commit ba2d283

File tree

4 files changed

+11
-8
lines changed

4 files changed

+11
-8
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,16 @@ curl -fsSL https://raw.githubusercontent.com/containers/ramalama/s/install.sh |
9898
| Command | Description |
9999
| ------------------------------------------------------ | ---------------------------------------------------------- |
100100
| [ramalama(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama.1.md) | primary RamaLama man page |
101+
| [ramalama-bench(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-bench.1.md)| benchmark specified AI Model |
101102
| [ramalama-containers(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-containers.1.md)| list all RamaLama containers |
103+
| [ramalama-convert(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-convert.1.md) | convert AI Model from local storage to OCI Image |
102104
| [ramalama-info(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-info.1.md) | display RamaLama configuration information |
105+
| [ramalama-inspect(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-inspect.1.md) | display RamaLama configuration information |
103106
| [ramalama-list(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-list.1.md) | list all downloaded AI Models |
104107
| [ramalama-login(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-login.1.md) | login to remote registry |
105108
| [ramalama-logout(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-logout.1.md) | logout from remote registry |
109+
| [ramalama-perplexity(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-perplexity.1.md)| calculate perplexity for specified AI Model |
106110
| [ramalama-pull(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-pull.1.md) | pull AI Model from Model registry to local storage |
107-
| [ramalama-convert(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-convert.1.md) | convert AI Model from local storage to OCI Image |
108111
| [ramalama-push(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-push.1.md) | push AI Model from local storage to remote registry |
109112
| [ramalama-rm(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-rm.1.md) | remove AI Model from local storage |
110113
| [ramalama-run(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-run.1.md) | run specified AI Model as a chatbot |

docs/ramalama-info.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
% ramalama-info 1
22

33
## NAME
4-
ramalama\-info - Display RamaLama configuration information
4+
ramalama\-info - display RamaLama configuration information
55

66

77
## SYNOPSIS

docs/ramalama.1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,19 +137,19 @@ show RamaLama version
137137

138138
| Command | Description |
139139
| ------------------------------------------------- | ---------------------------------------------------------- |
140-
| [ramalama-containers(1)](ramalama-containers.1.md)| list all RamaLama containers |
141140
| [ramalama-bench(1)](ramalama-bench.1.md) | benchmark specified AI Model |
141+
| [ramalama-containers(1)](ramalama-containers.1.md)| list all RamaLama containers |
142142
| [ramalama-convert(1)](ramalama-convert.1.md) | convert AI Models from local storage to OCI Image |
143-
| [ramalama-info(1)](ramalama-info.1.md) | Display RamaLama configuration information |
143+
| [ramalama-info(1)](ramalama-info.1.md) | display RamaLama configuration information |
144144
| [ramalama-inspect(1)](ramalama-inspect.1.md) | inspect the specified AI Model |
145145
| [ramalama-list(1)](ramalama-list.1.md) | list all downloaded AI Models |
146146
| [ramalama-login(1)](ramalama-login.1.md) | login to remote registry |
147147
| [ramalama-logout(1)](ramalama-logout.1.md) | logout from remote registry |
148+
| [ramalama-perplexity(1)](ramalama-perplexity.1.md)| calculate the perplexity value of an AI Model |
148149
| [ramalama-pull(1)](ramalama-pull.1.md) | pull AI Models from Model registries to local storage |
149150
| [ramalama-push(1)](ramalama-push.1.md) | push AI Models from local storage to remote registries |
150151
| [ramalama-rm(1)](ramalama-rm.1.md) | remove AI Models from local storage |
151152
| [ramalama-run(1)](ramalama-run.1.md) | run specified AI Model as a chatbot |
152-
| [ramalama-perplexity(1)](ramalama-perplexity.1.md)| calculate the perplexity value of an AI Model |
153153
| [ramalama-serve(1)](ramalama-serve.1.md) | serve REST API on specified AI Model |
154154
| [ramalama-stop(1)](ramalama-stop.1.md) | stop named container that is running AI Model |
155155
| [ramalama-version(1)](ramalama-version.1.md) | display version of RamaLama |

ramalama/cli.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,10 +238,10 @@ def configure_subcommands(parser):
238238
"""Add subcommand parsers to the main argument parser."""
239239
subparsers = parser.add_subparsers(dest="subcommand")
240240
subparsers.required = False
241-
help_parser(subparsers)
242241
bench_parser(subparsers)
243242
containers_parser(subparsers)
244243
convert_parser(subparsers)
244+
help_parser(subparsers)
245245
info_parser(subparsers)
246246
inspect_parser(subparsers)
247247
list_parser(subparsers)
@@ -501,7 +501,7 @@ def list_containers(args):
501501

502502

503503
def info_parser(subparsers):
504-
parser = subparsers.add_parser("info", help="Display information pertaining to setup of RamaLama.")
504+
parser = subparsers.add_parser("info", help="display information pertaining to setup of RamaLama.")
505505
parser.add_argument("--container", default=config.get('container', use_container()), help=argparse.SUPPRESS)
506506
parser.set_defaults(func=info_cli)
507507

@@ -625,7 +625,7 @@ def list_cli(args):
625625

626626

627627
def help_parser(subparsers):
628-
parser = subparsers.add_parser("help", help="help about any command")
628+
parser = subparsers.add_parser("help")
629629
# Do not run in a container
630630
parser.add_argument("--container", default=False, action="store_false", help=argparse.SUPPRESS)
631631
parser.set_defaults(func=help_cli)

0 commit comments

Comments
 (0)