Skip to content

Commit

Permalink
Merge pull request #967 from benmalef/add_doc_for_logFile
Browse files Browse the repository at this point in the history
Add documentation about the log file parameter
  • Loading branch information
sarthakpati authored Nov 12, 2024
2 parents 77ffe97 + a129624 commit 8aa4c2c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,14 @@ To split the data CSV into training, validation, and testing CSVs, the `gandlf s
-o $output_dir # the output directory to save the split data
```

### Using the `--log-file` parameter
By default, only the `info` and `error` logs will be **displayed** in the console and
the log file will be **saved** in `$(home)/.gandlf/<timestamp>.log`.

Also, you can use the `--log-file` and provide the file that you want to save the logs
```bash
(venv_gandlf) $> gandlf <command> --log-file <log_file_path>
```

## Customize the Training

Expand Down

0 comments on commit 8aa4c2c

Please sign in to comment.