wqael/notebooks

Notebooks Docker镜像文档

镜像概述和主要用途

Notebooks 是一个基于 Docker 的机器学习入门工具包，通过集成 Jupyter notebooks 提供便捷的运行时环境。该镜像旨在为用户简化机器学习环境配置流程，让用户无需关注复杂的环境搭建，即可快速拥有可用的 Jupyter notebooks 运行时，专注于机器学习模型开发与实验。

项目链接：https://github.com/rlan/notebooks

核心功能和特性

• 开箱即用的运行时环境：预配置 Jupyter notebooks，无需手动安装依赖，拉取镜像后即可启动使用。
• 环境一致性：基于 Docker 封装，确保不同设备、平台上的运行环境一致，避免“本地能跑，部署失败”的问题。
• 简化配置流程：集成机器学习常用依赖（推测，具体以项目实际为准），减少用户手动安装库的操作。
• 轻量便捷：专注于基础运行时需求，适合快速上手，无需复杂配置即可启动 Jupyter 交互界面。

使用场景和适用范围

适用场景

• 机器学习初学者入门：无需手动配置 Python、Jupyter 及相关依赖，快速启动交互式学习环境。
• 快速原型开发：研究人员或开发者可直接基于该环境进行模型原型设计与实验验证。
• 教学与培训环境：教师或培训者可统一部署该镜像，确保学员使用一致的开发环境，减少环境差异导致的问题。
• 个人项目开发：小型机器学习项目的本地开发与测试，通过 Docker 容器化管理，避免污染本地系统环境。

适用用户

• 机器学习/数据科学初学者
• 需要快速验证想法的研究人员
• 开发小型机器学习应用的开发者
• 开展编程教学或培训的教育工作者

详细使用方法和配置说明

前提条件

• 已安装 Docker 引擎（参考 https://docs.docker.com/engine/install/）
• 网络环境可访问 Docker Hub（用于拉取镜像）

基本使用步骤

1. 拉取镜像

从 Docker Hub 拉取最新版本镜像：

bash
docker pull docker.xuanyuan.run/wqael/notebooks:latest

如需指定版本，可替换 latest 为具体版本标签（如 v1.0，版本列表请参考 https://hub.docker.com/r/wqael/notebooks）。

2. 启动容器

使用 docker run 命令启动 Jupyter 服务容器：

bash
docker run -d \
  --name ml-notebooks \
  -p 8888:8888 \
  -v $(pwd)/notebooks:/home/jovyan/work \
  docker.xuanyuan.run/wqael/notebooks:latest

参数说明：

• -d：后台运行容器
• --name ml-notebooks：指定容器名称为 ml-notebooks（可自定义）
• -p 8888:8888：将容器内 Jupyter 默认端口（8888）映射到主机的 8888 端口（主机端口可自定义，如 -p 8080:8888）
• -v $(pwd)/notebooks:/home/jovyan/work：将主机当前目录下的 notebooks 文件夹挂载到容器内的工作目录（/home/jovyan/work，Jupyter 启动后默认访问此目录），实现数据持久化（避免容器删除后 notebook 文件丢失）

3. 访问 Jupyter 界面

1. 查看容器日志，获取 Jupyter 访问链接（包含 token）：

   bash
   docker logs ml-notebooks
   

   日志中通常会包含类似以下内容：
   http://127.0.0.1:8888/lab?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

2. 在浏览器中打开上述链接，即可访问 Jupyter Lab/Notebook 界面，开始使用。

配置参数与环境变量

常用环境变量

（基于 Jupyter 镜像常规配置推测，具体以项目实际为准，建议参考 https://github.com/rlan/notebooks 获取最新信息）

自定义配置示例

设置固定 token：

bash
docker run -d \
  --name ml-notebooks \
  -p 8888:8888 \
  -v $(pwd)/notebooks:/home/jovyan/work \
  -e JUPYTER_TOKEN="my_secure_token_123" \
  docker.xuanyuan.run/wqael/notebooks:latest

启动后可通过 http://localhost:8888/?token=my_secure_token_123 直接访问。

Docker Compose 配置示例

创建 docker-compose.yml 文件，简化容器管理：

yaml
version: '3'
services:
  notebooks:
    image: docker.xuanyuan.run/wqael/notebooks:latest
    container_name: ml-notebooks
    ports:
      - "8888:8888"
    volumes:
      - ./notebooks:/home/jovyan/work  # 本地工作目录挂载
      - ./data:/home/jovyan/data      # （可选）数据目录挂载
    environment:
      - JUPYTER_TOKEN=my_secure_token_123  # 自定义访问 token
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动服务：

bash
docker-compose up -d

停止服务：

bash
docker-compose down

参考信息

• 项目主页：https://github.com/rlan/notebooks
• Docker Hub 镜像页面：https://hub.docker.com/r/wqael/notebooks
• DOI：https://doi.org/10.5281/zenodo.***

注：本文档基于镜像公开描述整理，部分配置（如具体依赖、高级参数）可能随版本更新变化，建议通过上述链接获取最新技术细节。