跳到内容
新发行

对这个项目有疑问吗?注册一个免费的GitHub帐户以打开一个问题,并联系其维护者和社区。

单击“注册GitHub”,表示您同意我们的服务条款隐私声明。我们偶尔会向您发送与帐户相关的电子邮件。

已经在GitHub上了?登录到您的帐户

[REVIEW]:NN-SVG:出版物-就绪神经网络架构示意图 #747

关闭
36项任务中的18项
小麦已打开此问题2018年5月21日·48条评论
关闭
36项任务中的18项

[REVIEW]:NN-SVG:出版物-就绪神经网络架构示意图 #747

小麦已打开此问题2018年5月21日·48条评论
受让人
标签
认可的 出版 JOSS上发表的论文 推荐接受 JOSS推荐接受的论文。 回顾

评论

@小麦
复制链接

惠顿 评论2018年5月21日

提交作者:@兹夫兰切(亚历山大·勒奈尔)
存储库: https://github.com/zfrenchee/NN-SVG
版本:1.0.0
编辑: @阿丰
审核人: @尼罗河流域,@特里汤元
档案文件: 10.5281/zenodo.2541121

状态

地位

状态徽章代码:

HTML:<a href=“http://joss.theoj.org/papers/52b511ab107595a805107aa4ad70161d“><img src=”http://joss.theoj.org/papers/52b511ab107595a805107aa4ad70161d/status.svg“>”</a>降价:[![状态](http://joss.theoj.org/papers/52b511ab107595a805107aa4ad70161d/status.svg)](http://joss.theoj.org/papers/52b511ab107595a805107aa4ad70161d)

审查人和作者:

请避免在审查线索中详细说明困难。相反,请在目标存储库并在下面的评论线程中链接到这些问题(尤其是接受障碍)。(对于完美主义者:如果目标问题跟踪器也在GitHub上,则链接问题中的审阅线程或反之亦然,将在链接目标中创建相应的面包屑轨迹。)

审核人说明和问题

@尼罗河流域&@特里汤元,请通过更新下面的检查表来进行此问题的审查。如果您无法编辑检查表,请:

  1. 确保您已登录GitHub帐户
  2. 请确保接受此URL的邀请:https://github.com/openjournals/joss-reviews/invitations网站

审阅者指南可在此处获得:https://joss.theoj.org/about#reviewer_guidelines.如有任何问题/疑虑,请告知@阿丰知道了。

审查检查表@尼罗河流域

利益冲突

  • 作为审阅者,我确认我已经阅读了JOSS利益冲突政策而且我审查这项工作没有利益冲突。

行为准则

一般检查

  • 存储库:该软件的源代码在存储库url?
  • 许可证:存储库是否包含包含OSI批准软件许可证?
  • 版本:给定的版本是否与GitHub版本(1.0.0)匹配?
  • 作者:提交作者(@zfrenchee)是否对软件做出了重大贡献?论文作者的完整列表是否合适且完整?

功能

  • 安装:安装是否按照文档中的说明进行?
  • 功能:软件的功能声明是否得到确认?
  • 性能:如果软件有任何性能要求,是否得到确认?(如果没有索赔,请勾选此项。)

文档

  • 需求声明:作者是否清楚地说明了软件设计要解决的问题以及目标受众是谁?
  • 安装说明:是否有一个明确的依赖项列表?理想情况下,应该使用自动化包管理解决方案来处理这些问题。
  • 示例用法:作者是否包括如何使用该软件的示例(最好是解决现实世界中的分析问题)。
  • 功能文档:软件的核心功能是否记录到令人满意的水平(例如,API方法文档)?
  • 自动化测试:是否描述了自动化测试或手动步骤,以便验证软件的功能?
  • 社区指南:是否为希望1)为软件贡献力量2)报告软件问题3)寻求支持的第三方制定了明确的指导方针

软件论文

  • 作者:是否纸张.md文件中包含作者及其从属关系的列表?
  • 需求声明:作者是否清楚地说明了软件设计要解决的问题以及目标受众是谁?
  • 参考文献:所有应该有DOI的档案参考是否都列出了一个(例如,文件、数据集、软件)?

审查检查表@特里汤元

利益冲突

  • 作为审阅者,我确认我已经阅读了JOSS利益冲突政策而且我审查这项工作没有利益冲突。

行为准则

一般检查

  • 存储库:该软件的源代码在存储库url?
  • 许可证:存储库是否包含包含OSI批准软件许可证?
  • 版本:给定的版本是否与GitHub版本(1.0.0)匹配?
  • 作者:提交作者(@zfrenchee)是否对软件做出了重大贡献?论文作者的完整列表是否合适且完整?

功能

  • 安装:安装是否按照文档中的说明进行?
  • 功能:软件的功能声明是否得到确认?
  • 性能:如果软件有任何性能要求,是否得到确认?(如果没有索赔,请勾选此项。)

文档

  • 需求声明:作者是否清楚地说明了软件设计要解决的问题以及目标受众是谁?
  • 安装说明:是否有一个明确的依赖项列表?理想情况下,应该使用自动化包管理解决方案来处理这些问题。
  • 示例用法:作者是否包括如何使用该软件的示例(最好是解决现实世界中的分析问题)。
  • 功能文档:软件的核心功能是否记录到令人满意的水平(例如,API方法文档)?
  • 自动化测试:是否描述了自动化测试或手动步骤,以便验证软件的功能?
  • 社区指南:是否为希望1)为软件贡献力量2)报告软件问题3)寻求支持的第三方制定了明确的指导方针

软件论文

  • 作者:是否纸张.md文件中包含作者及其从属关系的列表?
  • 需求声明:作者是否清楚地说明了软件设计要解决的问题以及目标受众是谁?
  • 参考文献:所有应该有DOI的档案参考是否都列出了一个(例如,文件、数据集、软件)?
@小麦
复制链接
作者

你好,人类,我是@小麦。我来这里是为了帮助你完成一些常见的编辑任务。@尼罗河流域,看起来你目前被指派为这篇论文的审稿人🎉.

重要

如果您还没有,您应该认真考虑取消订阅GitHub通知(https://github.com/openjournals/joss-reviews网站)存储库。作为审阅者,您可能正在监视此存储库,这意味着对于GitHub的默认行为,您将收到所有审阅的通知(电子邮件)😿

要解决此问题,请执行以下两件事:

  1. 将自己设置为“不观看”https://github.com/openjournals/joss-reviews网站:

看

  1. 您可能还想在此处更改GitHub配置文件中此监视存储库的默认设置:https://github.com/settings/notifications网站

通知

要获得我可以帮助您的列表,只需键入:

@whedon命令

@小麦
复制链接
作者

正在尝试PDF编译。网状花键等。。。

@小麦
复制链接
作者

@阿丰
复制链接
成员

@尼罗河流域,@特里汤元-请通过更新上述检查表并在本期中提供反馈来进行本期审查。审阅者指南可在此处获得:http://joss.theoj.org/about评审指南

如有任何问题/疑虑,请告诉我。

@亚历山大
复制链接

您好!@尼罗河流域,@特里汤元,
感谢您同意对此进行审查!我现在要进行第一轮编辑,以符合我在上面看到的检查表——我可以看出已经缺少了一些东西。大约一个小时后,你们就可以复习了。

@亚历山大
复制链接

哦,还有关于这个项目的一个重要注意事项,@阿丰,@尼罗河流域,@特里汤元,
NN-SVG主要是一个网络工具,而不是一个包。尽管此项目是在考虑可扩展性的情况下构建的(我已经被联系过在其他地方使用它)本规范的主要目的是作为现场。因此,没有安装说明/API方法等。。。

所以我会在这些复选标记旁边加上N/a。

@阿丰
复制链接
成员

因此,没有安装说明/API方法等。。。

只是稍微推开这个@zfrenchee。虽然我知道这可能不是用一个干净的API包装在一个库/模块中,但我认为应该提供此软件的安装说明(即如何亲自运行此站点)。

@亚历山大
复制链接

@阿丰这是一个有趣的想法。再说一遍,它们只是HTML页面,所以我想不出太多要解释的东西。但我会继续考虑。。

@特里汤元
复制链接
成员

我已经完成了第一轮复习。几条反馈:

  • 我认为最好将其封装到一个干净的API中,例如,一个用例是在其他网站中动态呈现SVG。如果它只是一个一次性工具,不能在其他地方重用,我不确定是否值得提交给JOSS。
  • 由于上述原因,它还缺少文档中的内容,例如安装、API文档和自动测试(如果发生简单的错误,它很容易被破坏)。
  • 对于如何从其他人那里做出贡献,没有社区指南(考虑到这个领域的发展速度,如何扩展到新的NN结构,而不仅仅是LeNet、AlexNet、FCNN等)。
  • 值得一提的是其他类似的工具,例如TensorFlow运动场.

@亚历山大
复制链接

@特里汤元 @阿丰
感谢您的反馈,很抱歉延迟了回复。经过仔细思考,我发现你说得很对,如果我把它变成一段可以更广泛使用的独立代码,这个工具将更广泛地适用。不幸的是,这将需要相当多的重构和重新架构,而在不久的将来我可能没有时间去做这些。如果你同意的话,我就把这个问题留着,希望能在接下来的1-3周内解决。听起来不错吗?

@阿丰
复制链接
成员

感谢您的反馈,很抱歉延迟了回复。经过仔细思考,我发现你说得很对,如果我把它变成一段可以更广泛使用的独立代码,这个工具将更广泛地适用。不幸的是,这需要进行一些重构和重新架构,我可能在不久的将来没有时间去做这些。如果你同意的话,我就把这个问题留着,希望能在接下来的1-3周内解决。听起来不错吗?

是的,这完全可以。我会把这个标记为暂停现在-请让我知道,当你准备再次拿起这个线程。

@阿丰 阿丰补充这个暂停标签2018年6月15日
@亚历山大
复制链接

@阿丰 @特里汤元
我已经完成了重构。我相信现在可以在其他网站上使用这个工具了。
我可能仍然应该添加有关如何做到这一点的文档。除此之外,还需要做什么?前进的道路是什么?我应该添加文档,然后再进行一轮审查吗?

@阿利克斯奈尔
复制链接

@阿丰 @特里汤元
我写了一些文档:https://github.com/zfrenchee/NN-SVG/wiki/NN-SVG-API
我相信稍微更新一下这篇论文是有意义的,但我也认为我已经做好了下一轮复习的准备,除非我忘记了什么?

@亚历山大

@阿丰你能把“暂停”的标签去掉吗?

@阿丰 阿丰远离的这个暂停标签2018年7月22日
@阿丰
复制链接
成员

@尼罗河流域 @特里汤元-请过来再看看这个。

@阿丰
复制链接
成员

@尼罗河流域-你认为你能很快地进行复习吗?🙏

@亚历山大
复制链接

仍然希望看到此评论@阿丰

@特里汤元
复制链接
成员

酷。另外,你能谈谈我对社区指南的意见吗?

@特里汤元
复制链接
成员

也没有自动测试。您提供了一个快速教程,但没有记录任何API方法。

@亚历山大
复制链接

  • @特里汤元你能分享一个你所说的社区指南的例子吗?我没有在生物大熊猫.
  • @特里汤元我不确定可视化工具提供自动化测试是否有意义?
  • @特里汤元wiki记录了每个架构的所有API方法。每个架构只有2-3种方法,这可能会让您感到困惑?

@特里汤元
复制链接
成员

公共方法中没有对每个参数的描述。

您可以在此处找到示例:http://rasbt.github.io/biopandas/contension/#how(网址:http://rasbt.github.io/biopandas/contension/#how)-贡献
它位于README.md中:https://github.com/rasbt/biopandas#链接
您还可以在repo中提供CONTRIBUTING.md文件。

关于可视化工具的自动化测试,@阿丰有什么建议吗?

@阿丰
复制链接
成员

关于可视化工具的自动化测试,@阿丰有什么建议吗?

可视化是HTML格式的吗?如果是这样的话,像硒这样的东西可能很适合吗?

@亚历山大
复制链接

@阿丰这是一个很好的观点,但我认为这对这个项目来说太过分了。从我编写的小前端测试中,我可以看出这将需要2-3倍于我已经编写的代码来编写健壮的UI测试。这个应用程序似乎不需要这样做。你怎么认为?

@阿丰
复制链接
成员

@zfrenchee-是的,我听到了。自动化测试并不是JOSS的一个固定要求,但如果没有,则需要提供类似的东西(文档化的测试程序和示例数据等)。基本上,审查人员需要能够验证软件的功能。

@亚历山大
复制链接

@阿丰这很有道理。让我看看我能通过测试之类的方式找到什么。

@阿丰
复制链接
成员

@阿丰这很有道理。让我看看我能通过测试之类的方式找到什么。

你在@zfrenchee过得怎么样?

@阿丰
复制链接
成员

刚刚通过电子邮件向@zfrenchee发送了提醒。

@亚历山大
复制链接

我创建了一组简单的示例,演示如何启动和运行此项目:

https://github.com/zfrenchee/NN-SVG/wiki/Tests--Minimal-Examples

通过这些示例,您应该能够绘制NN,并使用API文档中列出的任何显示参数对其进行配置:

https://github.com/zfrenchee/NN-SVG/wiki/NN-SVG-API#iii-风格化网络

我认为一个合理的测试用例是克隆电子回购,复制粘贴一个最小的示例,验证您是否看到NN图,然后使用API以各种方式配置或样式它。

@阿丰
复制链接
成员

阿丰 评论2019年1月13日

谢谢@zfrenchee。

@特里汤元-你能看看@zfrenchee在这里添加的示例吗https://joss.readthedocs.io/en/latest/review_criteria.html#tests):

  • 可遵循记录的手动步骤客观检查软件的预期功能(例如,断言行为的示例输入文件)

@特里汤元
复制链接
成员

感谢@zfrenchee对这些问题的解决,谢谢@阿丰对于ping。看起来不错。你能回答我之前发表的以下评论吗?

  • 对于如何从其他人那里做出贡献,没有社区指南(考虑到这个领域的发展速度,如何扩展到新的NN结构,而不仅仅是LeNet、AlexNet、FCNN等)。
  • 缺少安装说明(这太琐碎了@阿丰我们需要这个吗?)

@阿丰
复制链接
成员

  • 缺少安装说明(这太琐碎了@阿丰我们需要这个吗?)

我想,由于这里的大多数依赖项都是从web上的CDN中提取的JavaScript库,也许我们不需要安装说明?

也就是说,最好在README(或wiki)中明确最终用户需要什么来生成这些数字。

@亚历山大
复制链接

您好!@阿丰,@terrytangyuan公司

  1. “安装说明”:wiki描述了通过CDN隐式包含在最小示例并在API文档

  2. 添加到wiki的贡献指南,并链接到自述文件中的。

@特里汤元
复制链接
成员

谢谢。我已经标记了清单中的所有项目。@阿丰现在交给你。

@阿丰
复制链接
成员

谢谢@特里汤元.

@zfrenchee-此时,您可以在Zenodo/f无花果共享/其他服务中对审查过的软件进行归档,并使用归档的DOI更新此线程吗?然后,我可以继续接受提交的内容。

@亚历山大
复制链接

@阿丰对不起,打扰了,你能告诉我关于这个步骤的更多信息吗?我在上面什么也没看到JOSS提交说明页面,我有点不确定别人问我什么。我听说我应该在zenodo上存档当前代码吗?只需从github下载一个回购zip并上传到zenodo就能实现这一点吗?

@阿丰
复制链接
成员

我是否正确地听到我应该在zenodo上存档当前代码?只需从github下载一个回购zip并上传到zenodo就能实现这一点吗?

是的,没错。如果您在审查期间对代码库/文档进行了重大更改,那么我们也鼓励您在GitHub上发布新版本。您可以按照本指南学习如何做到这一点:https://guides.github.com/activities/citable-code网站/

@亚历山大
复制链接

@阿丰
复制链接
成员

@小麦将10.5281/zenodo.2541121设置为存档

@小麦
复制链接
作者

好 啊。10.5281/zenodo.2541121是存档。

@阿丰
复制链接
成员

@小麦接受

@小麦
复制链接
作者

正在尝试试运行处理纸张验收。。。

@小麦
复制链接
作者

检查最终证明👉openjournals/joss-papers#435

如果PDF和Crossref文档存放XML看起来不错openjournals/joss-papers#435,然后您可以继续接受提交,方法是使用标志再次编译存款=真例如

@whedon accept deposit=真

@阿丰
复制链接
成员

@小麦接受存款=true

@小麦
复制链接
作者

现场直播!正在尝试自动处理纸张验收。。。

@小麦
复制链接
作者

🚨🚨🚨这不是演习,你刚刚把一篇论文交给了JOSS!🚨🚨🚨

以下是您现在必须执行的操作:

  1. 检查存放的最终PDF和Crossref元数据👉创建10.21105.joss.00747的拉入请求joss-papers第436号
  2. 等待几分钟,验证文件DOI是否解决https://doi.org/10.21105/joss.00747
  3. 如果一切看起来都很好,那么就结束这个审查问题。
  4. 派对就像你刚刚发表了一篇论文!🎉🌈🦄💃👻🤘

有什么问题吗?通知你的编辑技术团队。。。

@阿丰
复制链接
成员

@特里汤元-非常感谢你在这里的评论

@zfrenchee-你的论文现在被JOSS接受⚡🚀💥

@小麦
复制链接
作者

🎉🎉🎉 祝贺你的论文被录取!🎉🎉🎉

如果您想在自述文件中包含论文链接,请使用以下代码片段:

降价:[![DOI](http://joss.theoj.org/papers/10.21105/joss.00747/status.svg)](https://doi.org/10.21105/joss.00747)HTML格式:<a style=“border-width:0”href=“https://doi.org/10.21105/joss.00747"><img src=“http://joss.theoj.org/papers/10.21105/joss.00747/status.svg“alt=”内政部徽章“></a>重新结构化文本:..图像:http://joss.theoj.org/papers/10.21105/joss.00747/status.svg:目标:https://doi.org/10.21105/joss.00747

这就是它在您的文档中的外观:

内政部

我们需要你的帮助!

《开源软件杂志》是一份社区杂志,依靠志愿者的努力。若您愿意支持我们,请考虑采取以下一种(或两种)措施:

@亚历山大
复制链接

像你这样的派对刚刚发表了一篇论文!🎉🌈🦄💃👻🤘

谢谢你的评论,@特里汤元为了得到善意的支持,@阿丰。期待为这个社区做出贡献=)

@小麦 小麦补充出版 JOSS上发表的论文 建议接受 JOSS推荐接受的论文。标签2020年3月2日
免费注册 在GitHub上加入此对话.已经有账户了吗?登录以发表评论
标签
认可的 出版 发表在JOSS上的论文 推荐接受 JOSS推荐接受的论文。 回顾
项目
还没有
开发

没有分支或拉请求

4名参与者