NeuriCo
Autonomous AI research framework. Idea in, paper out.
Quick Reference
| |
|---|
| What it does | Takes a research idea (YAML) and autonomously runs the full research lifecycle: literature review, experiment design, code execution, analysis, paper writing, GitHub push |
| Input |
YAML file with 3 required fields:
title,
domain,
hypothesis |
|
Output | Code (
src/), results & plots (
results/), LaTeX paper (
paper_draft/), GitHub repo |
|
Providers | Claude Code, Codex, Gemini (OAuth login, not API keys) |
|
Install |
git clone https://github.com/ChicagoHAI/neurico && cd neurico && ./neurico setup |
|
Source |
github.com/ChicagoHAI/neurico — Chicago Human+AI Lab (ChicagoHAI), University of Chicago |
|
License | Apache 2.0 |
Requirements
Minimal (one of)
| Option | What you need |
|---|
| Docker (recommended) | INLINECODE7 + INLINECODE8 |
| Native |
git +
python>=3.10 +
uv |
Resource
Access to at least one AI coding CLI (OAuth login required):
Recommended
| What | Why |
|---|
GitHub token (classic, repo scope) | Auto-creates repos and pushes results. Create here |
Optional API Keys
| Key | Purpose |
|---|
| INLINECODE13 | LLM-based repo naming, IdeaHub fetching, paper-finder |
| INLINECODE14 |
Semantic Scholar literature search via paper-finder |
|
OPENROUTER_KEY | Multi-model access during experiments |
|
COHERE_API_KEY | Improves paper-finder ranking (~7% boost) |
|
HF_TOKEN | Hugging Face private models/datasets |
|
WANDB_API_KEY | Weights & Biases experiment tracking |
Setup Tiers
- - Basic: CLI login +
GITHUB_TOKEN -- full NeuriCo functionality - Enhanced: +
OPENAI_API_KEY -- LLM repo naming + IdeaHub support - Full: +
S2_API_KEY (+ optional COHERE_API_KEY) -- paper-finder literature search
Installation
Docker (recommended)
The Docker image is a pre-configured environment with Python, Node.js, AI coding CLIs (Claude Code, Codex, Gemini), and a full LaTeX installation for paper compilation -- so you don't have to install any of these yourself. All experiments run inside this container; nothing is installed on your host system beyond the cloned repo. The image is built from the open-source Dockerfile and hosted on GitHub Container Registry.
CODEBLOCK0
Or step by step:
CODEBLOCK1
Native
CODEBLOCK2
Invocation
Fastest: Fetch from IdeaHub and run
CODEBLOCK3
Browse ideas at IdeaHub, copy the URL, and run the command above. NeuriCo fetches the idea, creates a GitHub repo, runs experiments, writes a paper, and pushes everything.
From a YAML file
CODEBLOCK4
Run options
| Option | Description |
|---|
| INLINECODE23 | AI provider (default: claude) |
| INLINECODE24 |
Run locally without GitHub integration |
|
--write-paper | Generate LaTeX paper after experiments (default: on) |
|
--paper-style neurips\|icml\|acl\|ams | Paper format (default: neurips) |
|
--private | Create private GitHub repository |
Input Format
Only 3 fields required:
CODEBLOCK5
Optional fields: background (papers, datasets, code references), methodology (approach, steps, baselines, metrics), constraints (compute, time, memory, budget), expected_outputs, evaluation_criteria.
Full schema: ideas/schema.yaml
Output Format
CODEBLOCK6
Results are automatically pushed to the GitHub repo created during submission.
Supported Domains
| Domain | Examples |
|---|
| Artificial Intelligence | LLM evaluation, prompt engineering, AI agents |
| Machine Learning |
Training, evaluation, hyperparameter tuning |
| Data Science | EDA, statistical analysis, visualization |
| NLP | Language model experiments, text analysis |
| Computer Vision | Image processing, object detection |
| Reinforcement Learning | Agent training, policy evaluation |
| Systems | Performance benchmarking, optimization |
| Theory | Algorithmic analysis, proof verification |
| Scientific Computing | Simulations, numerical methods |
Configuration
CODEBLOCK7
Environment variables go in .env (copy from .env.example). See README for details.
Security
- - No secrets are uploaded. API keys and tokens stay local in your
.env file and are never committed, pushed, or sent anywhere beyond the APIs they authenticate with. Sensitive environment variables are explicitly filtered out from all subprocess calls and sanitized from logs. - Experiments run inside Docker. The container is isolated from your host system. The only host directories mounted are your config, templates, and workspace output folder.
- Open source. The entire codebase, including the Dockerfile and install script, is publicly auditable on GitHub.
- Built by ChicagoHAI — the Human+AI Lab at the University of Chicago.
NeuriCo
自主AI研究框架。输入想法,输出论文。
快速参考
| |
|---|
| 功能 | 接收研究想法(YAML格式),自主运行完整研究生命周期:文献综述、实验设计、代码执行、分析、论文撰写、GitHub推送 |
| 输入 |
YAML文件,包含3个必填字段:title(标题)、domain(领域)、hypothesis(假设) |
|
输出 | 代码(src/)、结果与图表(results/)、LaTeX论文(paper_draft/)、GitHub仓库 |
|
提供商 | Claude Code、Codex、Gemini(OAuth登录,非API密钥) |
|
安装 | git clone https://github.com/ChicagoHAI/neurico && cd neurico && ./neurico setup |
|
来源 |
github.com/ChicagoHAI/neurico — 芝加哥大学人+AI实验室(ChicagoHAI) |
|
许可证 | Apache 2.0 |
系统要求
最低要求(任选其一)
| 选项 | 所需条件 |
|---|
| Docker(推荐) | git + docker |
| 原生安装 |
git + python>=3.10 +
uv |
资源要求
至少一个AI编码CLI工具(需OAuth登录):
推荐配置
| 项目 | 原因 |
|---|
| GitHub令牌(经典版,repo权限) | 自动创建仓库并推送结果。在此创建 |
可选API密钥
| 密钥 | 用途 |
|---|
| OPENAIAPIKEY | 基于LLM的仓库命名、IdeaHub获取、论文查找 |
| S2APIKEY |
通过论文查找器进行Semantic Scholar文献搜索 |
| OPENROUTER_KEY | 实验期间的多模型访问 |
| COHERE
APIKEY | 提升论文查找器排序(约提升7%) |
| HF_TOKEN | Hugging Face私有模型/数据集 |
| WANDB
APIKEY | Weights & Biases实验追踪 |
设置层级
- - 基础版: CLI登录 + GITHUBTOKEN — 完整NeuriCo功能
- 增强版: + OPENAIAPIKEY — LLM仓库命名 + IdeaHub支持
- 完整版: + S2APIKEY(+ 可选COHEREAPI_KEY)— 论文查找器文献搜索
安装
Docker(推荐)
Docker镜像是一个预配置环境,包含Python、Node.js、AI编码CLI工具(Claude Code、Codex、Gemini)以及完整的LaTeX论文编译环境——因此您无需自行安装这些组件。所有实验均在容器内运行;除克隆的仓库外,主机系统无需安装任何内容。该镜像基于开源Dockerfile构建,托管于GitHub容器注册表。
bash
git clone https://github.com/ChicagoHAI/neurico && cd neurico
./neurico setup # 拉取Docker镜像,配置API密钥,引导CLI登录
或逐步操作:
bash
git clone https://github.com/ChicagoHAI/neurico && cd neurico
docker pull ghcr.io/chicagohai/neurico:latest
docker tag ghcr.io/chicagohai/neurico:latest chicagohai/neurico:latest
./neurico config # 配置API密钥
claude # 登录AI CLI(一次性操作,在主机上执行)
原生安装
bash
git clone https://github.com/ChicagoHAI/neurico && cd neurico
curl -LsSf https://astral.sh/uv/install.sh | sh
uv sync
cp .env.example .env # 编辑:添加您的API密钥
claude # 登录AI CLI
调用方式
最快方式:从IdeaHub获取并运行
bash
./neurico fetch --submit --run --provider claude
浏览IdeaHub上的想法,复制URL,运行上述命令。NeuriCo将获取想法、创建GitHub仓库、运行实验、撰写论文并推送所有内容。
从YAML文件运行
bash
./neurico submit path/to/idea.yaml
./neurico run --provider claude
运行选项
| 选项 | 描述 |
|---|
| --provider claude\ | gemini\ | codex | AI提供商(默认:claude) |
| --no-github |
本地运行,不集成GitHub |
| --write-paper | 实验后生成LaTeX论文(默认:开启) |
| --paper-style neurips\|icml\|acl\|ams | 论文格式(默认:neurips) |
| --private | 创建私有GitHub仓库 |
输入格式
仅需3个必填字段:
yaml
idea:
title: LLM能理解因果关系吗?
domain: artificial_intelligence
hypothesis: LLM能够区分因果关系和相关关系
可选字段:background(论文、数据集、代码参考)、methodology(方法、步骤、基线、指标)、constraints(计算、时间、内存、预算)、expectedoutputs、evaluationcriteria。
完整模式:ideas/schema.yaml
输出格式
workspace/<仓库名称>/
src/ # Python实验代码
results/ # 指标、图表、模型
paper_draft/ # LaTeX论文(使用--write-paper时)
logs/ # 执行日志
artifacts/ # 模型、检查点
.neurico/ # 原始想法规范
结果会自动推送到提交过程中创建的GitHub仓库。
支持领域
| 领域 | 示例 |
|---|
| 人工智能 | LLM评估、提示工程、AI智能体 |
| 机器学习 |
训练、评估、超参数调优 |
| 数据科学 | 探索性数据分析、统计分析、可视化 |
| 自然语言处理 | 语言模型实验、文本分析 |
| 计算机视觉 | 图像处理、目标检测 |
| 强化学习 | 智能体训练、策略评估 |
| 系统 | 性能基准测试、优化 |
| 理论 | 算法分析、证明验证 |
| 科学计算 | 模拟、数值方法 |
配置
bash
./neurico config # 交互式API密钥配置
./neurico setup # 完整设置向导
./neurico shell # 容器内交互式Shell
./neurico help # 显示所有命令
环境变量存放在.env文件中(从.env.example复制)。详情请参阅README。
安全性
- - 不上传任何机密信息。 API密钥和令牌保留在您本地的.env文件中,永远不会被提交、推送或发送到除认证API之外的任何地方。敏感环境变量会从所有子进程调用中明确过滤掉,并从日志中清理。
- 实验在Docker内运行。 容器与主机系统隔离。仅挂载配置、模板和工作区输出文件夹等主机目录。
- 开源。 整个代码库,包括Dockerfile和安装脚本,均在GitHub上公开可审计。
- 由ChicagoHAI构建 — 芝加哥大学人+AI实验室。