Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about the log file parameter #967

Merged
merged 2 commits into from
Nov 12, 2024
Merged

Add documentation about the log file parameter #967

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
415e9e2
add doc for --log-file
benmalef Nov 10, 2024
a129624
Merge branch 'master' into add_doc_for_logFile
sarthakpati Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/usage.md
View file
Open in desktop
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
Loading