Common research utilities for our NUIST-GenAI-Lab and CCGM tasks
Project description
cfskit
cfskit 是一个科研学术项目脚手架, 初版专注于3个功能点: 日志、实验可视化写入、进程信号控制, 并提供可运行的代码模板:
- nlab-lite-template: 轻量快速实验模板,保留 2-5 分钟快测闭环。
- nlab-template: 论文生命周期模板,面向调研、文档、agent 协作和 OpenClaw 托管实验。
配合这个统一的模板, 可以让所有论文代码复现、二次开发、新建项目在一开始就完成非逻辑性的结构改造,统一成规范标准、结构清晰的实验工程形态。
| 工具 | 模块 | 说明 |
|---|---|---|
| Logger | cfskit.log_util |
基于 loguru 的统一日志,tqdm 兼容,单次初始化 |
| Writer | cfskit.tb_util |
基于 TensorBoard 的实验可视化写入,多进程自动适配 |
| IPC | cfskit.ipc_util |
基于 SIGUSR1/SIGUSR2 的进程间信号量,支持优雅控制训练流程 |
基础 API
from cfskit import logger, setup_logger, setup_tensorboard, tb
setup_logger("output/demo/logs", name="nlab")
setup_tensorboard("output/demo/runs", name="nlab")
logger.info("experiment started")
tb.scalar("Loss/train", 0.1, step=1)
安装
pip install cfskit
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cfskit-0.1.2.tar.gz
(15.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
cfskit-0.1.2-py3-none-any.whl
(16.0 kB
view details)
File details
Details for the file cfskit-0.1.2.tar.gz.
File metadata
- Download URL: cfskit-0.1.2.tar.gz
- Upload date:
- Size: 15.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2cfc3e097c3bf0bd8527bb1524be01d965d4c5cb7eb55933fcb4ccec89d1b9ff
|
|
| MD5 |
315223a94b59caf64cc28d12a63bdab3
|
|
| BLAKE2b-256 |
ae4fa1da36b3b98ee8f5279c9abfa9fa6f6deb21cc39bf31c1e7006c7bcc0cf8
|
File details
Details for the file cfskit-0.1.2-py3-none-any.whl.
File metadata
- Download URL: cfskit-0.1.2-py3-none-any.whl
- Upload date:
- Size: 16.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9e8c637c4905e0466a3ff0ee08b5a4869b0a58b0fc8c8237fe2b9d03864d7a2d
|
|
| MD5 |
bf4cdf5537be25a27af118010c131127
|
|
| BLAKE2b-256 |
e2f08334b8de5d9c0d092756f4fd9385868f538b852ab649a2aed2d4503afd14
|