allenai / allenai/allenact

Documenting all the command line arguments

Open
#212 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
383
Forks
59
PR merge metrics
No merged PRs in 30d

Description

## Problem

[Creating an issue here following Luca's suggestion]
It might be beneficial for users if all the command line arguments in the `main.py` script were documented in the AllenAct docs. I ran into an issue (fixed now) where I accidentally started training from the latest checkpoint with the `restart_pipeline` flag for a run that had crashed prematurely -- my goal was to resume training as opposed starting an entirely new training run from a pre-trained checkpoint. Clarifying when to use different command line arguments (beyond the ones which are already documented) will be helpful.

## Desired solution

Explicitly documenting all the command line arguments.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.