Skip to content

Commit

Permalink
fix: fix docs and wording (#9179)
Browse files Browse the repository at this point in the history
  • Loading branch information
salonig23 authored Apr 16, 2024
1 parent 5541e54 commit d41c4a7
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/reference/experiment-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ Parameters include:
retention settings post-completion for a single trial or the entire experiment, you can use the
CLI command ``det t set log-retention <trial-id>`` or ``det e set log-retention <exp-id>``. Both
commands accept either the argument: ``--days``, which sets the number of days to retain logs
from the time of creation, or ``--forever`` which retains logs indefinitely.
from the end time of the task, or ``--forever`` which retains logs indefinitely.

Example configuration:

Expand Down
6 changes: 3 additions & 3 deletions harness/determined/cli/experiment.py
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ def set_log_retention(args: argparse.Namespace) -> None:
if not args.forever and not isinstance(args.days, int):
raise cli.CliError(
"Please provide an argument to set log retention. --days sets the number of days to"
" retain logs from the time of creation, eg. `det e set log-retention 1 --days 50`."
" retain logs from the end time of the task, eg. `det e set log-retention 1 --days 50`."
" --forever retains logs indefinitely, eg.`det e set log-retention 1 --forever`."
)
elif isinstance(args.days, int) and (args.days < -1 or args.days > 32767):
Expand Down Expand Up @@ -1332,8 +1332,8 @@ def experiment_id_arg(help: str) -> cli.Arg: # noqa: A002
cli.Arg(
"--days",
type=none_or_int,
help="from the time of creation, number of days to "
"retain the logs for. allowed range: -1 to 32767.",
help="number of days to retain the logs for, from the "
"end time of the task, . allowed range: -1 to 32767.",
),
cli.Arg(
"--forever",
Expand Down
6 changes: 3 additions & 3 deletions harness/determined/cli/trial.py
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ def set_log_retention(args: argparse.Namespace) -> None:
if not args.forever and not isinstance(args.days, int):
raise cli.CliError(
"Please provide an argument to set log retention. --days sets the number of days to"
" retain logs from the time of creation, eg. `det t set log-retention 1 --days 50`."
" retain logs from the end time of the task, eg. `det t set log-retention 1 --days 50`."
" --forever retains logs indefinitely, eg.`det t set log-retention 1 --forever`."
)
elif isinstance(args.days, int) and (args.days < -1 or args.days > 32767):
Expand Down Expand Up @@ -538,8 +538,8 @@ def create_json_file_in_dir(content: Any, file_path: str) -> None:
cli.Arg(
"--days",
type=none_or_int,
help="from the time of creation, number of days to "
"retain the logs for. allowed range: -1 to 32767.",
help="number of days to retain the logs for, from the "
"end time of the task, . allowed range: -1 to 32767.",
),
cli.Arg(
"--forever",
Expand Down
4 changes: 2 additions & 2 deletions proto/pkg/apiv1/experiment.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/pkg/apiv1/trial.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions proto/src/determined/api/v1/experiment.proto
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ message PutExperimentRetainLogsRequest {
// The ID of the experiment.
int32 experiment_id = 1;

// The number of days to retain logs, starting from the time of creation.
// The number of days to retain logs, starting from the end time of the task.
int32 num_days = 2;
}

Expand All @@ -170,7 +170,7 @@ message PutExperimentsRetainLogsRequest {
};
// The ids of the experiments being moved.
repeated int32 experiment_ids = 1;
// The number of days to retain logs, starting from the time of creation.
// The number of days to retain logs, starting from the end time of the task.
int32 num_days = 2;
// Targets all experiments matching filters.
BulkExperimentFilters filters = 3;
Expand Down
2 changes: 1 addition & 1 deletion proto/src/determined/api/v1/trial.proto
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ message PutTrialRetainLogsRequest {
// The ID of the trial.
int32 trial_id = 1;

// The number of days to retain logs, starting from the time of creation.
// The number of days to retain logs, starting from the end time of the task.
int32 num_days = 2;
}

Expand Down
6 changes: 3 additions & 3 deletions webui/react/src/services/api-ts-sdk/api.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d41c4a7

Please sign in to comment.