Skip to content

[misc] feat: Update file logger path output to absolute path#5924

Open
vermouth1992 wants to merge 1 commit intomainfrom
vermouth1992-patch-1
Open

[misc] feat: Update file logger path output to absolute path#5924
vermouth1992 wants to merge 1 commit intomainfrom
vermouth1992-patch-1

Conversation

@vermouth1992
Copy link
Copy Markdown
Collaborator

What does this PR do?

  • As title

Checklist Before Starting

  • Search for similar PRs. Paste at least one query link here: ...
  • Format the PR title as [{modules}] {type}: {description} (This will be checked by the CI)
    • {modules} include fsdp, megatron, veomni, sglang, vllm, rollout, trainer, ci, training_utils, recipe, hardware, deployment, ray, worker, single_controller, misc, perf, model, algo, env, tool, ckpt, doc, data, cfg, reward, fully_async, one_step_off
    • If this PR involves multiple modules, separate them with , like [megatron, fsdp, doc]
    • {type} is in feat, fix, refactor, chore, test
    • If this PR breaks any API (CLI arguments, config, function signature, etc.), add [BREAKING] to the beginning of the title.
    • Example: [BREAKING][fsdp, megatron] feat: dynamic batching

Test

For changes that can not be tested by CI (e.g., algorithm implementation, new model support), validate by experiment(s) and show results like training curve plots, evaluation results, etc.

API and Usage Example

Demonstrate how the API changes if any, and provide usage example(s) if possible.

# Add code snippet or script demonstrating how to use this

Design & Code Changes

Demonstrate the high-level design if this PR is complex, and list the specific changes.

Checklist Before Submitting

Important

Please check all the following items before requesting a review, otherwise the reviewer might deprioritize this PR for review.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the file logger initialization to display the absolute path of the log file. However, a critical issue was identified where the directory for the log file is not guaranteed to exist if the path is provided via environment variables, which could lead to a FileNotFoundError. It is recommended to ensure the directory is created using os.makedirs(os.path.dirname(self.filepath), exist_ok=True) before opening the file.

os.makedirs(directory, exist_ok=True)
self.filepath = os.path.join(directory, f"{self.experiment_name}.jsonl")
print(f"Creating file logger at {self.filepath}")
print(f"Creating file logger at {os.path.abspath(self.filepath)}")
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

While this change correctly makes the log message more informative, it highlights a pre-existing critical bug. If VERL_FILE_LOGGER_PATH is set from the environment, the directory for the specified path is not created, as os.makedirs is only called when the path is generated by the program. This will lead to a FileNotFoundError on line 267 if the directory doesn't exist.

The directory for self.filepath should be created before the file is opened, regardless of how the path is specified. A possible fix is to call os.makedirs(os.path.dirname(self.filepath), exist_ok=True) after self.filepath is determined.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

While this change correctly makes the log message more informative, it highlights a pre-existing critical bug. If VERL_FILE_LOGGER_PATH is set from the environment, the directory for the specified path is not created, as os.makedirs is only called when the path is generated by the program. This will lead to a FileNotFoundError on line 267 if the directory doesn't exist.

The directory for self.filepath should be created before the file is opened, regardless of how the path is specified. A possible fix is to call os.makedirs(os.path.dirname(self.filepath), exist_ok=True) after self.filepath is determined.

Could you propose a fix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant