模块通用签名

简介

为同一任务开发的模块应该采用一个通用签名,以便模块使用者能够轻松地换用不同模块,并找到最能解决其具体问题的模块。

此目录下包含通用签名的规范。我们预计,随着针对更多类型任务的模块不断开发出来,这个目录会逐渐扩大。

在理想情况下,只要遵循通用签名的规范来实现此类签名,就应该足以确保使用者只需调用 output = module(inputs) 即可,而无需对模块的内部原理有任何了解。如果需要做出调整,我们建议提供库函数来进行封装,并在文档中对库函数和签名加以说明。

在任何情况下,目标都是要让使用者能够轻松换用同一任务的不同模块,就像切换采用字符串值的超参数一样简单。

签名