pytorch / pytorch/rl

[Feature Request] Remove duplicated code from /examples

Open
#730 3 comments 0 reactions 1 assignee View on GitHub

@vmoens is already working on this.

Since Dec 7, 2022.

enhancement
Dominant language
Python
Stars
3.6k
Forks
484
Avg merge
1d 1h
Merged PRs (30d)
207

Description

Motivation

Hi, this is a small suggestion to refactor the code in the examples directory.

The reason for it is that different examples have a lot of code in common (see here, here and here for the examples). I guess this small change would increase the readability

Solution

I would suggest to create a utils.py file inside the examples dir and put the duplicated code here. For instance, for the logging example described above we could simply create get_logger(cfg: "DictConfig") function and import it inside examples if needed

Alternatives

Do nothing and close this issue :)

Additional context

If it seems as an OK improvement I would be able to create a PR and address this issue. Please let me know what you think!

Checklist

  • I have checked that there is no similar issue in the repo (required)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.