Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

论文列表结构如何调整 #38

Open
birdflyi opened this issue May 7, 2022 · 27 comments
Open

论文列表结构如何调整 #38

birdflyi opened this issue May 7, 2022 · 27 comments

Comments

@birdflyi
Copy link
Collaborator

birdflyi commented May 7, 2022

当前的论文列表结构为openlist.md,包含 |No. | Paper | Author | Conf&Journal | Year | Rank | Tags| 等列。
新的“论文推荐”流程体系中按论文7要素给出如下的模板:

  • 论文题目(Title)
  • 发表年份(Year)
  • 会议或期刊名称(Conference or Journal)
  • 级别(参照 CCF 级别)(Ranking)(可选)
  • 分类标签(参照 Opendium )(Lable)(可选)
  • 论文链接(Link)(可选)
  • 推荐理由(Recommendation reason)(可选)

对比差异:

  • Paper <-> 论文题目(Title) + 论文链接(Link)(可选)
  • Author <-> [空]
  • Year <-> 发表年份(Year)
  • Conf&Journal <-> 会议或期刊名称(Conference or Journal)
  • Rank <-> 级别(参照 CCF 级别)(Ranking)(可选)
  • Tags <-> 分类标签(参照 Opendium )(Lable)(可选)
  • Extra <-> 推荐理由(Recommendation reason)(可选)

讨论openlist.md论文列表结构的调整:

  1. 关于Paper是否需要更名为 其他名字(如Paper Title [Link] ),或是分离出单独的Title列与Link列?
  2. Author列是否是必要的?若必要,给出几名作者代表较合适?
  3. 推荐理由(Recommendation reason)(可选)是否需要体现在列表中?
    当前的方式是使用 Extra 中的 Tags&Reasons 列单独记录少数的特殊论文,并将原因记入SpecialReason.md(https://github.com/X-lab2017/open-research/blob/main/PaperRecomm/SpecialReason.md) 中。

欢迎讨论~

@will-ww
Copy link
Contributor

will-ww commented May 7, 2022

我觉得,是否应该尽量简洁,然后用链接的形式进行 issue 关联,这样openlist.md的结构可以考虑:

  • 论文编号
  • 论文题目(上面可以有外部链接)
  • 年份
  • 会议或期刊名称
  • 级别
  • 分类(只显示第一分类)
  • 下载链接(链接到我们语雀上的论文全文上)
  • 推荐理由(这个里面直接做个链接到对应的 issue 上)

“Author”我个人觉得不需要,比较长而且不规范,“推荐理由”也不能要,格式不标准,太长。 @birdflyi

@birdflyi
Copy link
Collaborator Author

birdflyi commented May 7, 2022

调整后如下表所示,其中Title上只带有原文下载链接,附件链接统一归在Links列下,增加了RecReasonRefIssue列用于关联特殊论文的推荐Issue或Comment上。

No. Title Conf&Journal Year Rank Tags Links RecReasonRefIssue
T1 What Makes a Great Maintainer of Open Source Projects? ICSE 2021 A A. 参与实体 [LocalLink], [Video], [Note]

注:原来的Author主要是用于团队识别,方便预判论文的领域视角,以及提供部分ArXiv上的零次文献的辅助信息设置的。

其他问题:考虑到大多数的Paper是正常推荐的,RecReasonRefIssue是否需要单独成列?Extra 表是否要与其他表合并?

@will-ww
Copy link
Contributor

will-ww commented May 7, 2022

  • No., 用一个编码体系表示
  • Title,挺好
  • Publication,出版物,代替 Conf&Journal
  • Year,OK
  • Clasification,分类,代替 Tag
  • Resource,代替Links,有包括四个部分:[Copy][Slide][Video][Note],分别链接:全文、PPT、视频、分享笔记
  • History:代替RecReasonRefIssue,历史最终,放入 issue 即可

如何?

@birdflyi
Copy link
Collaborator Author

birdflyi commented May 7, 2022

好的。
调整后如下表所示:

No. Title Publication Year Rank Clasification Resource History
T1 What Makes a Great Maintainer of Open Source Projects? ICSE 2021 A A. 参与实体 [Copy], [Video], [Note]  

其中:

  • No. 采用 编码体系 的讨论结果表示;
  • Title 中可含有指向刊物、论文数据库、doi等的外源链接;
  • Publication Year Rank 表示某出版物某年的CCF Rank(默认为CCF);
  • Clasification 采用MindMap中的分类体系;
  • Resource 包含[Copy][Slide][Video][Note],对应全文、PPT、视频、分享笔记;
  • History 为可选项,特殊文献的History关联相应的Issue。取消Extra 表格。

@will-ww
Copy link
Contributor

will-ww commented May 14, 2022

走了一遍从论文入库,到论文分享的流程,目前情况汇总如下:

  1. 请求论文入库阶段需要填写的信息包括,参考:https://github.com/X-lab2017/open-research/discussions/42
  • 题目
  • 会议或期刊名称
  • 年份
  • 级别
  • 分类或关键词
  • 推荐理由
  • 全文链接如下
  1. 请求分享论文阶段需要填写的信息包括,参考:[OpenPro] 2021-Sustainability Forecasting for Apache Incubator Projects-ESEC-FSE #40
  • Title 题目
  • Author and affiliation
  • Year 年份
  • Conference or Journal 会议或期刊名称
  • Ranking 级别
  • Label 分类
  • Link 链接
  • Select reason 选择理由
  • Supplementary 相关建议

因此,目前比较赞同娄博士提出的表结构,略作一些调整(9个字段):

  • No.(编号)四位的流水编号,例如:0001
  • Title(题目):可含有指向刊物、论文数据库、doi等的外部链接
  • Year(年份):四位,如:2022
  • Publication(刊物):发表的会议或期刊名称
  • Rank(级别):表示某出版物某年的CCF Rank(默认为CCF)
  • Keywords(关键词):1~5 个关键词
  • Clasification(分类体系):按照“开源纲目”进行整理与编号(Todo)
  • Resource(资料):包含[Copy][Slide][Video][Note],对应全文、PPT、视频、分享笔记,四个链接部分
  • History(历史记录):关联相应的Discussion、Issue 等历史记录

@will-ww
Copy link
Contributor

will-ww commented May 14, 2022

同时键入 Keywords 和 Clasification 的原因是,Keywords 作为论文入库时候的一个填入项目,简化入库流程的成本,等到正式阅读的时候,再填入 Clasification,填的时候也顺便参考 Keywords。

整个过程,就是不断丰富论文库列表信息项的过程:

  • 入库时,加入基本信息,例如 Keywords 等
  • 准备分享时,加入背景信息、Clasification 信息等
  • 分享过程中,在 Resource 中加入 PPT、视频等信息
  • 分享结束后,在 Resource 中加入 阅读笔记等信息
  • 整个复盘:通过 History 中的信息可以追踪

@xiaoya-yaya
Copy link
Member

我觉得入库的表结构没有问题~

推荐时,我建议可以像 open digger 提标签数据一样,直接用 Issue Template 给出论文推荐模板,Discussion 目前似乎还不支持模板功能,不过在 Discussion 下面的格式可以更加自由一些。

@will-ww
Copy link
Contributor

will-ww commented May 14, 2022

我觉得入库的表结构没有问题~

推荐时,我建议可以像 open digger 提标签数据一样,直接用 Issue Template 给出论文推荐模板,Discussion 目前似乎还不支持模板功能,不过在 Discussion 下面的格式可以更加自由一些。

对的,把模板进行工具化。

@bifenglin
Copy link
Contributor

bifenglin commented May 14, 2022

入库表结构没什么问题,我看到的流程是大家以issue的方式提出来,然后再由审核团队补充到OpenResearch/openList中是么?还有之前讨论的编号系统,这个现在只用流水号是么?

@will-ww
Copy link
Contributor

will-ww commented May 14, 2022

入库表结构没什么问题,我看到的流程是大家以issue的方式提出来,然后再由审核团队补充到OpenResearch/openList中是么?还有之前讨论的编号系统,这个现在只用流水号是么?

我是这么想的,像用 issue 的方式提出,然后人工添加到列表中(例如前期娄博),后面稳定成熟了,可以让一个 maintainer 团队来,甚至看能否自动化一下。

论文编号系统,因为“开源纲目”的整体还没设计好,所以暂时也不加。编号系统应该可以是一个自动生成的方式,且唯一。国际上已经有一个 DOI 系统了。目前看下来,还想也还没有特别需要的场景。可以再想想~

@bifenglin
Copy link
Contributor

bifenglin commented May 14, 2022

这个论文合并的过程可以补充到分享流程上去,关于请求分享论文阶段论文入库阶段是否有重叠,是否是请求分享论文阶段论文入库阶段之后,这样请求分享论文阶段理论上更新一个学期论文分享安排表这么一个文档即可。若是需要在github上留档的话,理论上以markdown文档的方式留档比issue的方式留档更好。

@will-ww
Copy link
Contributor

will-ww commented May 14, 2022

这个论文合并的过程可以补充到分享流程上去,关于请求分享论文阶段论文入库阶段是否有重叠,是否是请求分享论文阶段论文入库阶段之后,这样请求分享论文阶段理论上更新一个学期论文分享安排表这么一个文档即可。若是需要在github上留档的话,理论上以markdown文档的方式留档比issue的方式留档更好。

参见完整的流程:https://github.com/X-lab2017/open-research/tree/main/OpenReading

0、论文入库流程,1、提出候选论文。

没有 学期论文分享安排表 这个说法,只有一个论文列表库,以及一个每个学期的 组会安排,例如这学期的安排。这连个都是持续更新的 markdown 形式。最终都会落回到 论文列表库,这个是最终的输出物,后续我们会基于这个 markdown 文件,做个 Web 应用的。也许要需要把这个 markdown 形式的论文库,转换成一个类似 JSON 的文件。

@bifenglin
Copy link
Contributor

好的,这周我先跟翁振杰沟通试行一下,看一看流程是否有什么问题。

@bifenglin
Copy link
Contributor

论文PDF文件可以根据分类放在这里面。https://xlab2017.yuque.com/staff-kbz9wp/dtv0fr

will-ww added a commit that referenced this issue May 14, 2022
Update:根据#38#issuecomment-1126595612 调整openlist.md的文献入库格式
@will-ww
Copy link
Contributor

will-ww commented May 15, 2022

论文PDF文件可以根据分类放在这里面。https://xlab2017.yuque.com/staff-kbz9wp/dtv0fr

我们需要整合下,论文的存放地,目前有两个:

x-publication 的说明文档在这里:https://xlab2017.yuque.com/msdpvs/me6vqg/odtmme

你看看有啥建议~ @bifenglin

@birdflyi
Copy link
Collaborator Author

x-publication似乎需要分清楚内部和外部使用。这里默认使用外部公开的资源位置。
目前需要确认的资源位置:
[Copy] 使用X-GovOps/x-publication下的*-paper(语雀移动文件时不改变分享链接,建议先放入默认的未整理paper);
[Video] 使用bilibili Xlab2020公开发布链接;
[Note] 暂未统一,是否需要统一?
[Slide] 使用X-GovOps/x-publication下的*-slide

@bifenglin
Copy link
Contributor

好 那么使用x-publication比较好,这样统一一下,之前的x-share可以放一些其他内容,比如电子书 视频一类。

@will-ww
Copy link
Contributor

will-ww commented May 15, 2022

好 那么使用x-publication比较好,这样统一一下,之前的x-share可以放一些其他内容,比如电子书 视频一类。

电子书、视频等,里面也有了,你在仔细看看:https://xlab2017.yuque.com/msdpvs/me6vqg/odtmme

@will-ww
Copy link
Contributor

will-ww commented May 15, 2022

x-publication似乎需要分清楚内部和外部使用。这里默认使用外部公开的资源位置。 目前需要确认的资源位置: [Copy] 使用X-GovOps/x-publication下的*-paper(语雀移动文件时不改变分享链接,建议先放入默认的未整理paper); [Video] 使用bilibili Xlab2020公开发布链接; [Note] 暂未统一,是否需要统一? [Slide] 使用X-GovOps/x-publication下的*-slide

是的。https://xlab2017.yuque.com/msdpvs/me6vqg/odtmme

这个里面有详细的规划,看看是否合适。

image

[Note] 这块,可以放在这个目录下面:https://github.com/X-lab2017/open-research/tree/main/notes

@frank-zsy
Copy link
Collaborator

有两个问题:

1、如果 OpenRec 与 OpenPro 是渐进的关系,那么是否需要把信息再复制一遍,还是直接引用即可呢?因为即使是复制信息也可能出现错误。引用方式例如:

|0019| **Scaling open source communities**: An empirical study of the linux kernel |ICSE|2020|A||T[D0602.Evolution of Communities of Software]|||

2、对于论文的 PDF 原文,目前大家都是使用学校账号在不同的科研数据库中下载的,现在都以文件方式直接上传到语雀或 GitHub,是否有盗版的问题?是否保留数据库的相应原始链接即可?大家可以使用自己的学校账号进行论文下载。事实上非我们自己生产的其他数字资源也会有类似的问题,比如电子书等,不过看王老师这里 x-book 是内部使用应该问题不大。

@birdflyi
Copy link
Collaborator Author

论文PDF版权问题:
按理说本单位购买使用权情况下,合法用户将全文下载到本地硬盘以后,只能给本单位用户合法使用。
我们校内共享肯定是没问题的,副本链接改为实验室内部访问权限应该就可以;另外我们不分享的推荐论文关注也会少,仅在推荐记录中选用DOI链接或者二次文献的数据库链接应该影响不大。

@will-ww
Copy link
Contributor

will-ww commented May 15, 2022

有两个问题:

1、如果 OpenRec 与 OpenPro 是渐进的关系,那么是否需要把信息再复制一遍,还是直接引用即可呢?因为即使是复制信息也可能出现错误。引用方式例如:

|0019| **Scaling open source communities**: An empirical study of the linux kernel |ICSE|2020|A||T[D0602.Evolution of Communities of Software]|||

2、对于论文的 PDF 原文,目前大家都是使用学校账号在不同的科研数据库中下载的,现在都以文件方式直接上传到语雀或 GitHub,是否有盗版的问题?是否保留数据库的相应原始链接即可?大家可以使用自己的学校账号进行论文下载。事实上非我们自己生产的其他数字资源也会有类似的问题,比如电子书等,不过看王老师这里 x-book 是内部使用应该问题不大。

是的,这种引用还是很好的,看看怎么更好的用起来。

版权确实是个问题,所以除了论文以外的,我们就内部分享了。论文我们先开放,后续如果有问题,可以随时用权限隔离,我觉得问题不大。

@bifenglin
Copy link
Contributor

版权确实没有考虑到。不过除了知网的一些国内论文,国外的大多数论文都是可以公开访问下载。我认为问题不大。

@birdflyi
Copy link
Collaborator Author

x-publication似乎需要分清楚内部和外部使用。这里默认使用外部公开的资源位置。 目前需要确认的资源位置: [Copy] 使用X-GovOps/x-publication下的*-paper(语雀移动文件时不改变分享链接,建议先放入默认的未整理paper); [Video] 使用bilibili Xlab2020公开发布链接; [Note] 暂未统一,是否需要统一? [Slide] 使用X-GovOps/x-publication下的*-slide

是的。https://xlab2017.yuque.com/msdpvs/me6vqg/odtmme

这个里面有详细的规划,看看是否合适。

image

[Note] 这块,可以放在这个目录下面:https://github.com/X-lab2017/open-research/tree/main/notes

默认的资源位置-v1
[Copy] 使用X-GovOps/x-publication下的*-paper(语雀移动文件时不改变分享链接,若还无法确定分类,建议先放入资源/open-research(待整理),以提供入库资源链接,之后再移至适当位置);此项需统一使用语雀,方便必要时资源隔离;
[Video] 使用bilibili Xlab2020公开发布的视频链接
[Note] 使用本项目目录notes
[Slide] 使用X-GovOps/x-publication下的资源/All-Slides

@bifenglin
Copy link
Contributor

bifenglin commented May 16, 2022

现在流程问题根据https://github.com/X-lab2017/open-research/blob/main/RecPaper.md,#50 #44 已有两篇论文,需要入库,这个入库操作暂时由会议主持人来进行操作么?若是的话,可以在https://github.com/X-lab2017/open-research/blob/main/RecPaper.md中补充一下。 @will-ww

@will-ww
Copy link
Contributor

will-ww commented May 16, 2022

现在流程问题根据https://github.com/X-lab2017/open-research/blob/main/RecPaper.md,#50 #44 已有两篇论文,需要入库,这个入库操作暂时由会议主持人来进行操作么?若是的话,可以在https://github.com/X-lab2017/open-research/blob/main/RecPaper.md中补充一下。 @will-ww

我觉得最好是大家一起来补充,而不是主持人。主持人可以来提醒和协调。也或者大家可以轮流来作为maintainer,负责解决这些 issue。主持人可以作为兜底的人,轮流来维护这个仓库~

@tyn1998
Copy link
Member

tyn1998 commented May 29, 2022

这个入库操作暂时由会议主持人来进行操作么?

我也觉得每个人都自己提PR,还能熟悉协作流程~

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants