simpletransformers
simpletransformers copied to clipboard
`MultiModalClassificationModel` parameters descriptions are not informative
Is your feature request related to a problem? Please describe. Not related to a bug but related to documentation, MultiModalClassificationModel, the parameters:
- text_label (str, optional) - Column name to look for instead of the default "text". Note that the change will persist even after the method call terminates. That is, the args dictionary of the model itself will be modified.
Column name to look for what is the purpose of this argument? It's not specified. If it's _label
then why does it mention ...instead of the default "text"
- labels_label (str, optional) - Column name to look for instead of the default "labels". Note that the change will persist even after the method call terminates. That is, the args dictionary of the model itself will be modified.
Same in this, IMO it's important what this label is intended for should be the first sentence, examples are much better.
Describe the solution you'd like A clear and concise description of arguments, even if it means devs considered it to be common sense, actually describing the arguments is very useful for a person coming in from no where, instead of leaving it to user to be inferred
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.