feat: add experiment info

feat: add experiment template

README.md

@@ -1,3 +1,60 @@
 # 实验二：对率回归与预测病马死亡
 
-施工中…
+## 实验说明
+
+- 自行在 [`function.py`](./function.py) 中编写实现数据加载与预测病马死亡的对率回归算法。
+
+所有成功上传的评测结果均会被记录，但不会公开展示。
+
+评测次数不限，最终评测成绩取**最高分**。
+
+## 注意事项
+
+挑战赛与实验为两个**不同**的仓库，注意不要混淆！
+
+- 实验仓库，开头名称统一为 `Experiment`
+  - **有截止时间限制**！
+  - 记录成绩但不公开，并且**是实验成绩的一部分**。
+  - 最终成绩取最高分。
+- 挑战赛仓库，开头名称统一为 `Challenge`
+  - 无截止时间限制。
+  - 公开展示排行榜和最近的评测信息。
+
+---
+
+实验开始前必须在 [`function.py`](./function.py#L28-L29) 中填写自己的学号和姓名！
+
+- 可以自行导入其他库，需要在 [`requirements.txt`](./requirements.txt) 添加依赖，若未在 [`requirements.txt`](./requirements.txt) 中添加使用到的依赖，则无法自动评测，**不记录成绩**。
+- 需要在 [`function.py`](./function.py) 中实现完整的对率回归算法。
+- 若需设置其它参数，必须设置其默认值，否则将**无法通过**自动评测，**成绩为零**。
+- 自动评测脚本仅会加载 `train_logreg`、`predict_logreg` 和 `load_data` 函数，请勿修改函数名。
+- 本地调试完成后，**需要更新提交代码**，否则无法自动评测，**没有实验成绩**。
+- 评测的运行时间受机器性能影响，运行时间仅供参考。
+- 若有评测相关问题，请在[项目工单](https://git.intcplab.cn/LufsX/Evaluation-Backend/issues)处提出，或联系 QQ: `1968647927`。
+
+代码提交后会进行自动评测，评测所用的环境如下：
+
+- CPU: Intel Xeon(R) CPU E3-1231 v3 @ 3.40GHz
+- OS: Ubuntu 22.04.4 LTS
+- Python: 3.10.12
+- numpy: 2.1.1
+
+## 实验操作
+
+本次实验自带数据集，数据集在对应的 `data` 文件夹下。
+
+本次实验强烈建议将代码克隆/下载到本地进行实验调试。
+
+---
+
+注意 ⚠️
+
+若要完成实验，请确保是在**本页面**点击「使用模版」来创建仓库，新仓库名称建议与本模版名称 `Experiment-LogReg` 相同，其余操作参见[挑战赛的说明](https://git.intcplab.cn/LufsX/Challenge-kNN#挑战操作)。
+
+若要完成实验，评测时检查创建完成的**仓库信息**是否正确，本次实验标题为「**实验二：对率回归与预测病马死亡**」！
+
+## 其它
+
+若有流程、优化等相关建议和问题，欢迎在[评测后端项目工单](https://git.intcplab.cn/LufsX/Evaluation-Backend/issues)中提出。
+
+同时欢迎参与[评测后端](https://git.intcplab.cn/LufsX/Evaluation-Backend)的开发与优化！

function.py

@@ -0,0 +1,83 @@
+# function.py
+import numpy as np
+
+"""
+实验说明:
+- 自行编写实现数据加载与预测病马死亡的对率回归算法。
+
+注意事项:
+- 在 function.py 中实现对率回归算法。
+- 可以自行导入其他库，需要在 requirements.txt 添加依赖，若未在 requirements.txt 中添加使用到的依赖，则无法自动评测，成绩为零。
+- 自动评测脚本仅会加载 train_logreg、predict_logreg 和 load_data 函数，请勿修改函数名。
+
+测评环境:
+- CPU: Intel Xeon(R) CPU E3-1231 v3 @ 3.40GHz
+- OS: Ubuntu 22.04.4 LTS
+- Python: 3.10.12
+- numpy: 2.1.1
+"""
+
+
+"""
+请在这里填写学号和姓名，不填写即成绩无效。
+"""
+id = "202210423xxx"
+name = "test_name"
+
+
+# 这里写自己的代码实现
+def train_logreg(X, y, other_params="你自己设置一些其它参数"):
+    """
+    对率回归训练函数。
+
+    Args:
+    - X (numpy array): 特征数据。
+    - y (numpy array): 标签数据。
+    - other_params (str): 其它参数，可选设置。若需设置其它参数，必须设置其默认值，否则将**无法通过**自动评测，**成绩为零**。
+
+    Returns:
+    - numpy array: 训练得到的权重。
+    """
+
+
+def predict_logreg(inX, weights):
+    """
+    对率回归预测函数。
+
+    Args:
+    - inX (numpy array): 输入待分类的样本。
+    - weights (numpy array): 训练得到的权重。
+
+    Returns:
+    - int: 预测的分类标签。
+    """
+
+
+# 这里也写自己的代码实现
+def load_data(filepath):
+    """
+    从文件中加载数据，若不自行正确实现，则无法通过评测，**不记录成绩**。
+
+    Args:
+    - directory (str): 数据文件路径。
+
+    Returns:
+    - np.array: 特征数据。
+    - np.array: 标签数据。
+    """
+
+
+if __name__ == "__main__":
+    # 以下代码可用于测试，可自行随意修改
+    # 加载训练集
+    X_train, y_train = load_data("./data/horse-colic.data")
+
+    # 加载测试集
+    X_test, y_test = load_data("./data/horse-colic.test")
+
+    # 训练对率回归模型
+    weights = train_logreg(X_train, y_train, learning_rate=0.01, iterations=1000)
+
+    # 测试单个数据
+    y_pred = predict_logreg(X_test[11], weights)
+    print(f"预测结果: {y_pred}, 实际结果: {y_test[11]}")

requirements.txt

@@ -0,0 +1,2 @@
+numpy==2.1.1
+requests==2.32.3