pluv/HeurAMS

Fork 0

Files

T

pluv f88475499f docs: 修改文档

2026-05-20 23:49:30 +08:00

5.5 KiB

Raw Blame History

HeurAMS "潜进" - 启发式辅助记忆调度器

中文 | English

概述

HeurAMS "潜进" (Heuristic Auxiliary Memorizing Scheduler, 启发式记忆辅助调度器) 是一种基于启发式算法与认知科学理论的辅助记忆调度器, 旨在帮助用户更高效地进行记忆工作与学习规划,
也是一种开放, 优雅, 易于扩展的间隔重复调度器实验平台, 旨在帮助研究者更高效地进行前沿记忆算法的调查实验与研究.

详细介绍屏幕截图

快速开始

安装软件

从包管理器安装

潜进 (包名是 heurams) 处于早期开发考虑, 尚未上架 PyPI.
但可以用 pip 从仓库安装稳定版和开发版本, 这要求设备上安装了 python 环境 (建议 3.12.13 及之后版本).

从稳定的 master 分支安装, 并安装适用于用户体验的可选依赖(推荐):

pip install --upgrade 'heurams[basic] @ https://git.pluv27.top/pluv/HeurAMS/archive/master.zip'

从较前沿, 大致稳定的 dev 分支安装, 并安装适用于用户体验的可选依赖(如果您追求较前沿的改进):

pip install --force-reinstall --no-deps 'heurams[basic] @ https://git.pluv27.top/pluv/HeurAMS/archive/dev.zip'

安装适用于一般计算机的通用音频模块 (基于 playsound3):
(此项不适用于 termux 环境, termux 的音频支持是内建的)

pip install --upgrade 'heurams[audio-playsound] @ https://git.pluv27.top/pluv/HeurAMS/archive/master.zip'

您也可以从 refactor/... 等特定分支安装以测试某项更改

依赖分组说明

从源码安装

我们提供原生 python 和 uv 两种源码安装方式.
详见贡献指南 - 设置开发环境.

使用软件

在终端中运行 heurams, 您会看到一系列帮助信息, 例如:

~ $ heurams
Usage: heurams [OPTIONS] COMMAND [ARGS]...

  HeurAMS 0.5.1 - 启发式辅助记忆调度器

Options:
  -v, --version  Show the version and exit.
  -h, --help     Show this message and exit.

Commands:
  help     显示此帮助信息
  tui      启动内置基本用户界面 (TUI)
  version  输出版本信息

可以通过键入 heurams tui 启动基本用户界面, 例如:

~ $ heurams tui
欢迎使用基本用户界面!
加载配置与上下文... 已完成! (耗时: 2ms)
加载用户界面框架... 已完成! (耗时: 89ms)
加载用户界面布局... 已完成! (耗时: 56ms)
组件目录: <软件包所在目录>
工作目录: <运行目录, 将在此目录下建立 ./data 文件夹>
前置工作共计耗时: 147ms

(此时您的终端将转为呈现美观的 TUI 基本用户界面)

通过键入 heurams -v 查看版本:

~ $ heurams -v
HeurAMS 0.5.1 stable (fulcrum/支点), Linux

常见问题 (FAQ)

详见常见问题.

项目架构

详见架构说明.

参与项目

欢迎参与到项目协作中!
详见贡献指南.
关于 AI 辅助开发的说明, 请参阅 AGENTS.md.

项目标识

HeurAMS 项目标识如下, 文件(位图和矢量图)位于 ./src/heurams/assets/art/ 目录.

颜色分别是: #1660A5 (海蓝色) #545F70 (蓝灰色) #FFFFFF (单色明亮图标白色) #1A1A1A (单色暗色图标深黑色) #2f2f35 (文字颜色).

许可证

项目本身

本项目基于 AGPL-3.0 许可证开放源代码, 并有一个豁免本机 API 调用的附加条款, 较标准 AGPL-3.0 更宽松.

详见根目录下 LICENSE 文件.

第三方代码

项目在 src/heurams/vendor/ 目录下嵌入或在其他位置直接使用了以下第三方代码或其衍生作品 (可能有修改):

SM.js

上游版本: commit 6e3bb4a (2015年2月4日上游已停止维护)
引用方式: 将 coffeescript 重写为 python 并间接引用, 数学原理一致; 并对重写后代码进行逻辑, 性能与标准化 API 改进
位置: src/heurams/kernel/algorithms/sm15m.py
原项目: SM.js
原许可证: MIT License

本项目受益于他们无私且优秀的工作.

5.5 KiB Raw Blame History