Skip to content
This repository has been archived by the owner on May 6, 2024. It is now read-only.

Default savedir to None (and remove unused archivefile) #174

Merged
merged 2 commits into from
Jun 23, 2021
Merged

Conversation

tscmoo
Copy link
Contributor

@tscmoo tscmoo commented Jun 21, 2021

savedir is a feature that will save ttyrecs of runs - this can be unexpected when training a model and may write a huge amount of unwanted files.

This changes the default to not save ttyrecs.

If you want ttyrecs to be saved, please specify savedir when instantiating the env from now on.

archivefile is a parameter that may have been used at some point, but is currently unused, so let's remove it.

savedir is a feature that will save ttyrecs of runs - this can be unexpected when training a model and may write a *huge* amount of unwanted files.

This changes the default to *not* save ttyrecs.

If you want ttyrecs to be saved, please specify savedir when instantiating the env from now on.

`archivefile` is a parameter that may have been used at some point, but is currently unused, so let's remove it.
@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 21, 2021
Copy link
Contributor

@cdmatters cdmatters left a comment

Choose a reason for hiding this comment

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

Generally sensible wrt savedir, but we need to communicate these changes to AIcrowd.

WRT archivefile: this will break the benchmark training we provide to contestants and if we go ahead, release should be timed to match update of model, action space, etc...

In general, we should just consider that removing archivefile is a breaking change to NLE api - why are we so certain we don't want an archivefile that keeps track of stats from all the ttyrecs that env created? I think this would be useful if you are generating 1000s of ttyrecs, so I think we should think twice before breaking the api, lest we need it again in future.

@cdmatters
Copy link
Contributor

cdmatters commented Jun 21, 2021

Indeed - I would suggest fixing archivefile and getting a stats/index file that I believe was demonstrably useful for the NLE paper, rather than just canning the last vestigial artifect.

@@ -186,8 +186,7 @@ class StepStatus(enum.IntEnum):

def __init__(
self,
savedir="",
archivefile="nethack.%(pid)i.%(time)s.zip",
Copy link
Contributor

Choose a reason for hiding this comment

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

After talking to Eric he convinced me to leave this here for now in order to not confuse participants too much.

Let's just remove savedir in this PR (and also the archivefile=None calls above, given that the argument gets ignored) and we'll deal with archivefile in a future PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can archivefile be defaulted to None, too, then? Same argument as for savedir

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes.

@cdmatters
Copy link
Contributor

@tscmoo any chance of reverting the deletion of archive file? happy to accept if so

1 similar comment
@cdmatters
Copy link
Contributor

@tscmoo any chance of reverting the deletion of archive file? happy to accept if so

Copy link
Contributor

@heiner heiner left a comment

Choose a reason for hiding this comment

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

LGTM.

Let's clean this up when we can.

@cdmatters
Copy link
Contributor

Have done w @heiner, and will accept.

@tscmoo
Copy link
Contributor Author

tscmoo commented Jun 23, 2021

Ah, sorry, forgot about this. I'll merge it once the tests pass.

@cdmatters cdmatters mentioned this pull request Jun 23, 2021
@cdmatters
Copy link
Contributor

cdmatters commented Jun 23, 2021

Flaky test failing is probably down to starting with 'female gnomish archaeol-More-'.. Rerunning test and will submit a test fix.

@cdmatters
Copy link
Contributor

Test fix is in #182

@tscmoo tscmoo merged commit 6fcf55c into master Jun 23, 2021
@heiner heiner deleted the savedir-none branch July 7, 2021 10:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants