Clay 基础模型

一个用于地球的开源人工智能模型和接口。

快速开始

在以下环境中启动 JupyterLab：

Binder	SageMaker Studio Lab

安装

基本安装

要参与开发，首先克隆这个 仓库地址

git clone <仓库地址>
cd model

然后我们建议使用 mamba 来安装依赖项。这将创建一个虚拟环境，其中安装了 Python 和 JupyterLab。

mamba env create --file environment.yml

[!注意] 上述命令仅适用于带有 CUDA GPU 的 Linux 设备。对于 macOS 设备（无论是 Intel 还是 ARM 芯片），请参考 https://clay-foundation.github.io/model/getting-started/installation.html#advanced 中的"高级"部分

首先激活虚拟环境。

mamba activate claymodel

最后，再次检查是否已安装库。

mamba list

使用

运行 jupyter lab

mamba activate claymodel
python -m ipykernel install --user --name claymodel  # 正确安装虚拟环境
jupyter kernelspec list --json                       # 查看内核是否已安装
jupyter lab &

运行模型

神经网络模型可以通过 LightningCLI v2 运行。要查看可用的不同选项和超参数配置，请运行：

python trainer.py --help

要在验证集上快速测试一个批次的模型：

python trainer.py fit --model ClayMAEModule --data ClayDataModule --config configs/config.yaml --trainer.fast_dev_run=True

要训练模型：

python trainer.py fit --model ClayMAEModule --data ClayDataModule --config configs/config.yaml

更多选项可以通过 python trainer.py fit --help 或 LightningCLI 文档 找到。

贡献

编写文档

我们的文档使用 Jupyter Book。

通过以下命令安装：

pip install -U jupyter-book

然后用以下命令构建：

jupyter-book build docs/

你可以通过以下方式在本地预览网站：

python -m http.server --directory _build/html

在 ./github/workflows/deploy-docs.yml 中有一个 GitHub Action，用于构建网站并将其推送到 GitHub Pages。