古老的启发式知识库
----------------------------------

|GitHub许可| |可维护性| |GitHub make-a-pull-requests|

BOHR是一个用于软件工程工件准备(标记、分组、链接、过滤)的启发方法的**存储库，例如提交、bug报告、代码片段等。软件工程(SE)和挖掘软件仓库(MSR)领域的研究人员通常需要准备这些工件，将从软件仓库(如GitHub、StackOverflow)中挖掘的工件转换为数据集，以便用于经验实验和训练机器学习模型。例如，可以将从GitHub挖掘的提交分类为bug修复等，以便创建一个训练数据集来训练机器学习模型。

手工准备每个工件是昂贵的，而且不能很好地扩展。因此，BOHR提供了一种定义启发式(短函数)的方法来自动完成工作。尽管使用启发式通常不如让专家分析每个工件准确，但我们声称，使用大量不同的启发式并“巧妙地”将它们组合起来，与使用单一启发式相比，可以显著减少噪声。启发式的组合方式取决于任务的类型，但最常见的方法之一是使用' snorkel  ' _，最先进的'弱监督 ' _工具使用的算法。

．．内容:内容:* * * *
反向链接:没有


任务和启发式的例子
=======================================

提交分类
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

一个例子是将从GitHub挖掘的提交分类为“bug修复”和“非bug修复”，以便创建一个训练数据集来训练机器学习模型。

．．python代码:

#……其他进口

从bohrapi。核心导入启发式
从bohrlabels。核心导入OneOrManyLabels

从bohrapi。工件导入提交
从bohrlabels。导入CommitLabel


@Heuristic(提交)
def bugless_if_many_files_changes(commit: commit) -> OneOrManyLabels:
如果len(commit.commit_files) > 15:
CommitLabel返回。NonBugFix
其他:
回来没有

在线身份分组
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


需要注意的重要事项:

#。启发式用' ' Heuristic ' '装饰器标记，它所应用的工件类型作为参数传递给启发式;
#。工件实例作为函数参数向启发式公开;工件对象的属性可以用于实现逻辑;
#。由启发式分配给工件的标签是在传递的工件对象上执行的结果;启发式必须分配BOHR标签层次结构中定义的标签之一，如果它在数据点上弃权，则分配“None”。




待定:稍后在什么地方插入?

** *简化了**添加新的启发式**和**评估其有效性的过程**;
** *标记向BOHR注册的数据集**，一旦添加启发式，**自动更新标签**;
*跟踪生成的数据集和模型的每个版本所使用的启发式方法，并且，一般来说，通过使用' DVC  ' _确保它们是**可复制的**和**容易访问的**。



主要概念(可能在README中不需要，而在文档中需要)
＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝

玻尔标准是一个“启发式”的知识库，因此，启发式是玻尔标准中的一个主要概念。接受相同或不同类型的工件或多个工件的子程序(python函数)。

工件是BOHR的抽象，它表示软件工程工件——SE活动的产物，例如。编码，提交，软件项目，软件仓库，发布报告。*Dataset*是同一类型工件的集合。

*Task*是一个抽象概念，描述了研究人员在BOHR方面正在研究的问题。任务的输入和输出是数据集。任务类型是标记、分组、链接和过滤。通过指定应用启发式的工件类型、启发式的可能输出、如何组合启发式的策略、用于评估启发式有效性的测试数据集和指标来定义任务。

*实验*是尝试使用一组特定的启发式(和训练数据，如果需要)来解决一个任务。


波尔工作流
===================================


1一个。对于给定的任务，利用社区开发的现有启发式
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

“波尔克隆https://github.com/giganticode/bohr-workdir-bugginess”

这将把对应于<任务>的所谓BOHR工作目录克隆到<路径>

3检查现有的带标签的数据集是否适合您的目的。
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

每个任务都附带一个经过训练的分类器和由该分类器标记的默认数据集。检查默认数据集是否适合您的目的。

' ' cd buggness -work-dir && Bohr pull default ' '

将显示加载数据集的路径。

4.用默认分类器为自己的数据集贴上标签。
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

' ' $ Bohr dataset add ~/new_commit_dataset.csv ' '
' ' $ Bohr任务添加数据集错误new_commit_dataset——repro ' '

5.开发一个新的启发式
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``$ vi heuristics/commit_files.py``


6.通过在独立测试集中检查启发式的覆盖率和准确性来调试和调优启发式
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

“$ Bohr repro”

7.使用新的启发式向远程BOHR存储库提交一个拉请求
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

“$ Bohr upload”


作为ci管道的一部分，在独立测试集上训练标签模型并计算指标。如果指标得到了改进，新的启发式被添加到BOHR中，并可供其他研究人员使用。

8.添加一个新任务
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
' ' $ Bohr任务添加纠缠提交\ ' '
“…- l TangledCommit.NonTangled TangledCommit。纠结的\ ' '
“…——再生产”“


安装
==============

待办事项:添加其他回购的链接

预印本和出版物
=============================

如果您在您的研究中使用BOHR，请引用我们:

．．代码块::

@inproceedings {babii2021mining,
title={用协同启发式库挖掘软件库}，
{Babii, Hlib和Prenner, Julian Aron和Stricker, Laurin和Karmakar, Anjan和Janes, Andrea和robes, Romain}，
书名={2021年IEEE/ACM第43届软件工程国际会议:新思想和新成果(ICSE-NIER)}，
页面= {106 - 110},
年= {2021},
组织= {IEEE}
｝


．．|GitHub license| image:: https://img.shields.io/github/license/giganticode/bohr.svg
:目标:https://github.com/giganticode/bohr/blob/master/LICENSE

．．GitHub make-a-pull-requests| image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
:目标:http://makeapullrequest.com

．．|可维护性|映像::https://codeclimate.com/github/giganticode/bohr/badges/gpa.svg
:目标:https://codeclimate.com/github/giganticode/bohr
:alt:代码气候