Skip to content

Commit 3784be4

Browse files
committed
Added --help and -seed
1 parent b8cf6b6 commit 3784be4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

examples/main/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,12 @@ By utilizing context management options like `--ctx_size` and `--keep`, you can
108108

109109
The following options are related to controlling the text generation process, influencing the diversity, creativity, and quality of the generated text. Understanding these options will help you fine-tune the output according to your needs:
110110

111+
### RNG Seed
112+
113+
- `-s SEED, --seed SEED`: Set the random number generator (RNG) seed (default: -1).
114+
115+
The RNG seed is used to initialize the random number generator that influences the text generation process. By setting a specific seed value, you can obtain consistent and reproducible results across multiple runs with the same input and settings. This can be helpful for testing, debugging, or comparing the effects of different options on the generated text to see when they diverge. If the seed is set to a value less than or equal to 0, a random seed will be used, which will result in different outputs on each run.
116+
111117
### Temperature
112118

113119
- `--temp N`: Adjust the randomness of the generated text (default: 0.8).
@@ -160,6 +166,7 @@ By understanding and using these performance tuning settings, you can optimize t
160166

161167
These options provide extra functionality and customization when running the LLaMA models:
162168

169+
- `-h, --help`: Display a help message showing all available options and their default values. This is particularly useful for checking the latest options and default values, as they can change frequently, and the information in this document may become outdated.
163170
- `--verbose-prompt`: Print the prompt before generating text.
164171
- `--mtest`: Test the model's functionality by running a series of tests to ensure it's working properly.
165172
- `--lora FNAME`: Apply a LoRA (Layer-wise Relevance Approximation) adapter to the model (implies --no-mmap). This allows you to adapt the pretrained model to specific tasks or domains.

0 commit comments

Comments
 (0)