user_guide icon indicating copy to clipboard operation
user_guide copied to clipboard

No reference documentation for `cwltool:CUDARequirement`

Open fmigneault opened this issue 2 years ago • 2 comments

There is no current definition in https://www.commonwl.org/v1.2/CommandLineTool.html for cwltool:CUDARequirement. Considering it is the "core" CWL specification, this is understandable.

However, it is mentioned in http://www.commonwl.org/user_guide/introduction/basic-concepts.html#processes-and-requirements and other tools have also added support for it:

  • https://doc.arvados.org/v2.4/user/cwl/cwl-extensions.html#CUDARequirement
  • https://github.com/DataBiosphere/toil/pull/4223
  • https://github.com/crim-ca/weaver/pull/494

It would be very helpful to have an official location where this is documented. It could be placed in an "extensions" section to highlight that it is not core CWL.

fmigneault avatar Nov 23 '22 23:11 fmigneault

Hello @fmigneault

I agree that proper documentation for extensions like this one are missing. https://github.com/common-workflow-language/common-workflow-language/issues/323 also talks about this

In addition to a rendered schema for the extensions, it would be good to have a list of which CWL implementstions support the extension and the standards track status (not-planned, planned-but-unscheduled, pending-cwl-v1.3, etc..)

mr-c avatar Nov 24 '22 10:11 mr-c

Thanks to the discussion https://github.com/crim-ca/weaver/pull/506#discussion_r1037890712 and the pointer to https://github.com/common-workflow-language/cwltool/blob/main/cwltool/extensions-v1.2.yml, I found quite a lot of other useful requirements like Secrets that I was not even aware of their existence.

To help in new user adoption of available utilities, I think this documentation should be prioritized.

fmigneault avatar Dec 02 '22 18:12 fmigneault