assignment1-basics 的安装和配置教程

项目基础介绍

assignment1-basics 是斯坦福大学 CS336 语言模型从零开始的项目。该项目旨在让学生通过实现基本的语言模型来了解自然语言处理的基础知识。该项目主要使用 Python 编程语言。

项目使用的关键技术和框架

本项目主要使用了以下技术和框架：

• Python：作为主要的编程语言。
• Pytest：用于编写和运行单元测试。
• uv：用于管理项目环境和依赖。

项目安装和配置准备工作

在开始安装和配置项目之前，请确保你的计算机上已经安装了以下软件：

• Python（推荐版本 3.8 或以上）
• pip（Python 的包管理工具）
• Git（用于克隆和操作项目代码）

安装步骤

步骤 1：克隆项目仓库

首先，你需要将项目代码克隆到本地计算机上。打开命令行窗口，执行以下命令：

git clone https://github.com/stanford-cs336/assignment1-basics.git
cd assignment1-basics

步骤 2：安装 uv

uv 是一个项目管理工具，用于管理项目环境和依赖。在项目目录下，执行以下命令安装 uv：

pip install uv

或者，如果你使用的是 macOS，也可以使用以下命令：

brew install uv

步骤 3：安装项目依赖

使用 uv 安装项目所需的所有依赖。在项目目录下，执行以下命令：

uv install

步骤 4：下载数据集

项目需要一些数据集来进行训练和验证。在项目目录下，执行以下命令下载数据集：

mkdir -p data
cd data
wget https://huggingface.co/datasets/roneneldan/TinyStories/resolve/main/TinyStoriesV2-GPT4-train.txt
wget https://huggingface.co/datasets/roneneldan/TinyStories/resolve/main/TinyStoriesV2-GPT4-valid.txt
wget https://huggingface.co/datasets/stanford-cs336/owt-sample/resolve/main/owt_train.txt.gz
gunzip owt_train.txt.gz
wget https://huggingface.co/datasets/stanford-cs336/owt-sample/resolve/main/owt_valid.txt.gz
gunzip owt_valid.txt.gz
cd ..

步骤 5：运行单元测试

在项目目录下，执行以下命令运行单元测试：

uv run pytest

初始时，所有测试应该会失败，显示 NotImplementedError。这是因为需要你完成 tests/adapters.py 文件中的函数实现。

完成以上步骤后，你已经成功安装和配置了 assignment1-basics 项目。接下来，你可以开始根据项目要求和指导文档，进行语言模型的实现和测试。