README.md

🤗 Hugging Face • ⏬ Data • 📖 Tutorial
中文 | English

DevOps-Eval is a comprehensive evaluation suite specifically designed for foundation models in the DevOps field. We hope DevOps-Eval could help developers, especially in the DevOps field, track the progress and analyze the important strengths/shortcomings of their models.

📚 This repo contains questions and exercises related to DevOps, including the AIOps.

💥️ There are currently 5977 multiple-choice questions spanning 8 diverse general categories, as shown below.

🔥 There are a total of 2840 samples in the AIOps subcategory, covering scenarios such as log parsing, time series anomaly detection, time series classification, time series forecasting, and root cause analysis.

🔔 News

• [2023.11.27] Add 487 operation scene samples and 640 time series forecasting samples; Update the Leaderboard;
• [2023.10.30] Add the AIOps Leaderboard.
• [2023.10.25] Add the AIOps samples, including log parsing, time series anomaly detection, time series classification and root cause analysis.
• [2023.10.18] Update the initial Leaderboard...

📜 Table of Contents

• 🏆 Leaderboard
  • 👀 DevOps
  • 🔥 AIOps
• ⏬ Data
  • 👀 Notes
  • 🔥 AIOps Sample Example
• 🚀 How to Evaluate
• 🧭 TODO
• 🏁 Licenses
• 😃 Citation

🏆 Leaderboard

Below are zero-shot and five-shot accuracies from the models that we evaluate in the initial release. We note that five-shot performance is better than zero-shot for many instruction-tuned models.

👀 DevOps

Zero Shot

ModelName	plan	code	build	test	release	deploy	operate	monitor	AVG
DevOpsPal-14B-Chat	60.61	78.35	84.86	84.65	87.26	82.75	69.89	79.17	78.23
DevOpsPal-14B-Base	54.55	77.82	83.49	85.96	86.32	81.96	71.18	82.41	78.23
Qwen-14B-Chat	60.61	75.4	85.32	84.21	89.62	82.75	69.57	80.56	77.18
Qwen-14B-Base	57.58	73.81	84.4	85.53	86.32	81.18	70.05	80.09	76.19
Baichuan2-13B-Base	60.61	69.42	79.82	79.82	82.55	81.18	70.37	83.8	73.73
Baichuan2-13B-Chat	60.61	68.43	77.98	80.7	81.6	83.53	67.63	84.72	72.9
DevOpsPal-7B-Chat	54.55	69.11	83.94	82.02	76.89	80	64.73	77.78	71.92
DevOpsPal-7B-Base	54.55	68.96	82.11	78.95	80.66	76.47	65.54	78.7	71.69
Qwen-7B-Base	53.03	68.13	78.9	75.44	80.19	80	65.06	80.09	71.09
Qwen-7B-Chat	57.58	66.01	80.28	79.82	76.89	77.65	62.64	79.17	69.75
Baichuan2-7B-Chat	54.55	63.66	77.98	76.32	71.7	73.33	59.42	79.63	66.97
Internlm-7B-Chat	60.61	62.15	77.06	76.32	66.98	74.51	60.39	78.24	66.27
Baichuan2-7B-Base	56.06	62.45	75.69	70.61	74.06	69.8	61.67	75.93	66.21
Internlm-7B-Base	54.55	58.29	79.36	78.95	77.83	70.59	65.86	75.93	65.99

Five Shot

ModelName	plan	code	build	test	release	deploy	operate	monitor	AVG
DevOpsPal-14B-Chat	63.64	79.49	81.65	85.96	86.79	86.67	72.95	81.48	79.69
DevOpsPal-14B-Base	62.12	80.55	82.57	85.53	85.85	84.71	71.98	80.09	79.63
Qwen-14B-Chat	65.15	76	82.57	85.53	84.91	84.31	70.85	81.48	77.81
Qwen-14B-Base	66.67	76.15	84.4	85.53	86.32	80.39	72.46	80.56	77.56
Baichuan2-13B-Base	63.64	71.39	80.73	82.46	81.13	84.31	73.75	85.19	75.8
Qwen-7B-Base	75.76	72.52	78.9	81.14	83.96	81.18	70.37	81.94	75.36
Baichuan2-13B-Chat	62.12	69.95	76.61	84.21	83.49	79.61	71.98	80.56	74.12
DevOpsPal-7B-Chat	66.67	69.95	83.94	81.14	80.19	82.75	68.6	76.85	73.61
DevOpsPal-7B-Base	69.7	69.49	82.11	81.14	82.55	82.35	67.15	79.17	73.35
Qwen-7B-Chat	65.15	66.54	82.57	81.58	81.6	81.18	65.38	81.02	71.69
Baichuan2-7B-Base	60.61	67.22	76.61	75	77.83	78.43	67.31	79.63	70.8
Internlm-7B-Chat	60.61	63.06	79.82	80.26	67.92	75.69	60.06	77.31	69.21
Baichuan2-7B-Chat	60.61	64.95	81.19	75.88	71.23	75.69	64.9	79.17	69.05
Internlm-7B-Base	62.12	65.25	77.52	80.7	74.06	78.82	63.45	75.46	67.17

🔥 AIOps

Zero Shot

ModelName	LogParsing	RootCauseAnalysis	TimeSeriesAnomalyDetection	TimeSeriesClassification	TimeSeriesForecasting	AVG
Qwen-14B-Base	66.29	58.8	25.33	43.5	62.5	52.25
DevOpsPal-14B—Base	63.14	53.6	23.33	43.5	64.06	50.49
Qwen-14B-Chat	64.57	51.6	22.67	36	62.5	48.94
DevOpsPal-14B—Chat	60	56	24	43	57.81	48.8
Qwen-7B-Base	50	39.2	22.67	54	43.75	41.48
DevOpsPal-7B—Chat	56.57	30.4	25.33	45	44.06	40.92
Baichuan2-13B-Chat	64	18	21.33	37.5	46.88	39.3
Qwen-7B-Chat	57.43	38.8	22.33	39.5	25.31	36.97
Internlm-7B—Chat	58.86	8.8	22.33	28.5	51.25	36.34
Baichuan2-7B-Chat	60.86	10	28	34.5	39.06	36.34
Baichuan2-7B-Base	53.43	12.8	27.67	36.5	40.31	35.49
Baichuan2-13B-Base	54	12.4	23	34.5	42.81	34.86
DevOpsPal-7B—Base	46.57	20.8	25	34	38.75	33.94
Internlm-7B—Base	48.57	18.8	23.33	37.5	33.75	33.1

One Shot

ModelName	LogParsing	RootCauseAnalysis	TimeSeriesAnomalyDetection	TimeSeriesClassification	TimeSeriesForecasting	AVG
DevOpsPal-14B—Chat	66.29	80.8	23.33	44.5	56.25	54.44
DevOpsPal-14B—Base	60	74	25.33	43.5	52.5	51.13
Qwen-14B-Base	64.29	74.4	28	48.5	40.31	50.77
Qwen-7B-Base	56	60.8	27.67	44	57.19	49.44
Qwen-14B-Chat	49.71	65.6	28.67	48	42.19	46.13
Baichuan2-13B-Base	56	43.2	24.33	41	46.88	42.89
Baichuan2-7B-Chat	58.57	31.6	27	31.5	51.88	41.83
DevOpsPal-7B—Base	52.86	44.4	28	44.5	36.25	41.2
Baichuan2-7B-Base	48.29	40.4	27	42	40.94	39.86
Qwen-7B-Chat	54.57	52	29.67	26.5	27.19	38.73
Baichuan2-13B-Chat	57.43	44.4	25	25.5	30.63	37.75
DevOpsPal-7B—Chat	56.57	27.2	25.33	41.5	33.44	37.46
Internlm-7B—Chat	62.57	12.8	22.33	21	50.31	36.69
Internlm-7B—Base	48	33.2	29	35	31.56	35.85

⏬ Data

Download

• Method 1: Download the zip file (you can also simply open the following link with the browser):

  wget https://huggingface.co/datasets/codefuse-admin/devopseval-exam/resolve/main/devopseval-exam.zip
  

  then unzip it and you may load the data with pandas:

  import os
  import pandas as pd
  
  File_Dir="devopseval-exam"
  test_df=pd.read_csv(os.path.join(File_Dir,"test","UnitTesting.csv"))
  

• Method 2: Directly load the dataset using Hugging Face datasets:

  from datasets import load_dataset
  dataset=load_dataset(r"DevOps-Eval/devopseval-exam",name="UnitTesting")
  
  print(dataset['val'][0])
  # {"id": 1, "question": "单元测试应该覆盖以下哪些方面？", "A": "正常路径", "B": "异常路径", "C": "边界值条件"，"D": 所有以上，"answer": "D", "explanation": ""}  ```

👀 Notes

To facilitate usage, we have organized the category name handlers and English/Chinese names corresponding to 55 subcategories. Please refer to category_mapping.json for details. The format is:

{
  "UnitTesting.csv": [
    "unit testing",
    "单元测试",
    {"dev": 5, "test": 32}
    "TEST"
  ],
  ...
  "file_name":[
  "English Name",
  "Chinese Name",
  "Sample Number",
  "Supercatagory Label(PLAN,CODE,BUILD,TEST,RELEASE,DEPOLY,OPERATE,MONITOR choose 1 out of 8)"
  ]
}

Each subcategory consists of two splits: dev and test. The dev set per subcategory consists of five exemplars with explanations for few-shot evaluation. And the test set is for model evaluation. Labels on the test split are also released.

Below is a dev example from 'version control':

id: 4
question: 如何找到Git特定提交中已更改的文件列表？
A: 使用命令 `git diff --name-only SHA`
B: 使用命令 `git log --name-only SHA`
C: 使用命令 `git commit --name-only SHA`
D: 使用命令 `git clone --name-only SHA`
answer: A
explanation: 
分析原因：
git diff --name-only SHA命令会显示与SHA参数对应的提交中已修改的文件列表。参数--name-only让命令只输出文件名，而忽略其他信息。其它选项中的命令并不能实现此功能。

🔥 AIOps Sample Example

👀 👀 Taking log parsing and time series anomaly detection as examples, here is a brief showcase of the AIOps samples:

LogParsing

id: 0
question:
Here are some running logs
 0 04:21:15,429 WARN Cannot open channel to 2 at election address /10.10.34.12:3888
 1 19:18:56,377 WARN ******* GOODBYE /10.10.34.11:52703 ********
 2 19:13:46,128 WARN ******* GOODBYE /10.10.34.11:52308 ********
 3 19:16:26,268 WARN ******* GOODBYE /10.10.34.11:52502 ********
 4 09:11:16,012 WARN Cannot open channel to 3 at election address /10.10.34.13:3888
 5 16:37:13,837 WARN Cannot open channel to 2 at election address /10.10.34.12:3888
 6 09:09:16,008 WARN Cannot open channel to 3 at election address /10.10.34.13:3888
 7 15:27:03,681 WARN Cannot open channel to 3 at election address /10.10.34.13:3888
The first three parts of the log are index, timestamp, and log level. Without considering these three parts, Here we assume that the variables in the logs are represented as '<*>', separated by spaces between tokens. What is the specific log template for the above logs? 
A: Notification time out: <*> 和 Connection broken for id <*>, my id = <*>, error =
B: Send worker leaving thread 和 Connection broken for id <*>, my id = <*>, error =
C: Received connection request /<*>:<*> 和 Interrupting SendWorker
D: Cannot open channel to <*> at election address /<*>:<*> 和 ******* GOODBYE /<*>:<*> ********
answer: D
explanation: The log includes the fixed template fragments "Cannot open channel to <> at election address /<>:<>" and "****** GOODBYE /<>:<> ********," both of which appear in option D. Meanwhile, the template fragments in the other options do not match the content in the log. Therefore, option D is the most consistent with the log template.

TimeSeriesAnomalyDetection

id: 0
question:
Analyze the following time series
[50,62,74,84,92,97,99,98,94,87,77,65,265,40,28,17,8,3,0,0,4,10,20,31,43,56,68,79,89,95,99,99,96,91,82,71,59,46,34,22,12,5,1,0,2,7,15,25,37,49]
Please identify the indices of obvious outlier points. Outlier points generally refer to points that significantly deviate from the overall trend of the data.
A: 46
B: 0
C: 37
D: 12
answer: D
explanation: According to the analysis, the value 265 in the given time series at 12 o'clock is significantly larger than the surrounding data, indicating a sudden increase phenomenon. Therefore, selecting option D is correct.

🚀 How to Evaluate

If you need to test your own huggingface-formatted model, the overall steps are as follows:

1. Write the loader function for the model.
2. Write the context_builder function for the model.
3. Register the model in the configuration file.
4. Run the testing script. If the model does not require any special processing after loading, and the input does not need to be converted to a specific format (e.g. chatml format or other human-bot formats), you can directly proceed to step 4 to initiate the testing.

1. Write the loader function

If the model requires additional processing after loading (e.g. adjusting the tokenizer), you need to inherit the ModelAndTokenizerLoader class in src.context_builder.context_builder_family.py and override the corresponding load_model and load_tokenizer functions. You can refer to the following example:

class QwenModelAndTokenizerLoader(ModelAndTokenizerLoader):
    def __init__(self):
        super().__init__()
        pass
    
    @override
    def load_model(self, model_path: str):
    # Implementation of the method
        pass
    
    @override
    def load_tokenizer(self, model_path: str):
    # Implementation of the method
        pass

2. Write the context_builder function for the Model

If the input needs to be converted to a specific format (e.g. chatml format or other human-bot formats), you need to inherit the ContextBuilder class in src.context_builder.context_builder_family and override the make_context function. This function is used to convert the input to the corresponding required format. An example is shown below:

class QwenChatContextBuilder(ContextBuilder):
    def __init__(self):
        super().__init__()
        
    @override
    def make_context(self, model, tokenizer, query: str, system: str = "hello！"):
    # Implementation of the method
        pass

3. Register the model in the configuration file

Go to the model_conf.json file in the conf directory and register the corresponding model name and the loader and context_builder that will be used for this model. Simply write the class names defined in the first and second steps for the loader and context_builder. Here is an example:

{
  "Qwen-Chat": {
  "loader": "QwenModelAndTokenizerLoader",
  "context_builder": "QwenChatContextBuilder"
  }
}

4. Execute the testing script

Run the following code to initiate the test:

python src/run_eval.py \
--model_path path_to_model \
--model_name model_name_in_conf \
--model_conf_path path_to_model_conf \
--eval_dataset_list all \
--eval_dataset_fp_conf_path path_to_dataset_conf \
--eval_dataset_type test \
--data_path path_to_downloaded_devops_eval_data \
--k_shot 0

👀 👀 The specific evaluation process is as follows 📖 Evaluate Tutorial

🧭 TODO

• add AIOps samples.
• add AIOps scenario time series forecasting.
• increase in sample size.
• add samples with the difficulty level set to hard.
• add the English version of the samples.

🏁 Licenses

This project is licensed under the Apache License (Version 2.0).

😃 Citation

Please cite our paper if you use our dataset.

Coming Soon...