facebookresearch/ParlAI

"maxlen" in parlai.core.torch_agent.History actually does nothing

Open

#3,013 opened on Aug 26, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (10,371 stars) (2,089 forks)batch import
Help WantedMinornever-stale

Description

https://github.com/facebookresearch/ParlAI/blob/c7f4b64df1a706464c053f036fe2ff38600f4558/parlai/core/torch_agent.py#L209

I think the description

  • maxlen – sets the maximum number of tunrs

should be changed to

  • size – sets the maximum number of tunrs

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Review the docstring of the 'maxlen' parameter in the History class in parlai/core/torch agent.py (around line 209). Confirm that the parameter 'maxlen' has no effect and that the intended parameter is 'size'. Then update the documentation accordingly.