diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index aa20cfda62..4a8eaf0f34 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -11,7 +11,7 @@ on: - "README.md" - "packages/hub/README.md" - "packages/inference/README.md" - - "packages/agents/README.md" + - "packages/tiny-agents/README.md" - ".github/workflows/documentation.yml" jobs: diff --git a/.github/workflows/pr-documentation.yml b/.github/workflows/pr-documentation.yml index 69d73b689d..49f06d6c72 100644 --- a/.github/workflows/pr-documentation.yml +++ b/.github/workflows/pr-documentation.yml @@ -8,7 +8,7 @@ on: - "packages/hub/README.md" - "packages/doc-internal/**" - "packages/inference/README.md" - - "packages/agents/README.md" + - "packages/tiny-agents/README.md" concurrency: group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} diff --git a/docs/_toctree.yml b/docs/_toctree.yml index 7b8008de96..833be5cc0f 100644 --- a/docs/_toctree.yml +++ b/docs/_toctree.yml @@ -18,14 +18,12 @@ isExpanded: true sections: - local: mcp-client/README - title: Simple MCP Client and smol Agent built on top of Inference Client -- title: "@huggingface/agent" + title: Simple MCP Client built on top of Inference Client +- title: "@huggingface/tiny-agents" isExpanded: true sections: - - local: agents/README - title: Use Agents to run multi-modal workflows from a natural language API - - local: agents/modules - title: API Reference + - local: tiny-agents/README + title: A lightweight MCP-powered Agent built on top of Inference Client - title: "@huggingface/space-header" isExpanded: true sections: diff --git a/packages/doc-internal/package.json b/packages/doc-internal/package.json index e5fee81ed1..429afcc6e7 100644 --- a/packages/doc-internal/package.json +++ b/packages/doc-internal/package.json @@ -5,16 +5,16 @@ "description": "Package to generate doc for other @huggingface packages", "private": true, "scripts": { - "start": "pnpm run fix-cdn-versions && pnpm run doc-hub && pnpm run doc-inference && pnpm run doc-agents && pnpm run doc-space-header && pnpm run doc-gguf && pnpm run doc-mcp-client && cp ../../README.md ../../docs/index.md && pnpm run update-toc && pnpm run fix-md-links && pnpm run fix-md-headinghashlinks", + "start": "pnpm run fix-cdn-versions && pnpm run doc-hub && pnpm run doc-inference && pnpm run doc-space-header && pnpm run doc-gguf && pnpm run doc-mcp-client && pnpm run doc-tiny-agents && cp ../../README.md ../../docs/index.md && pnpm run update-toc && pnpm run fix-md-links && pnpm run fix-md-headinghashlinks", "lint": "eslint --quiet --fix --ext .cjs,.ts .", "lint:check": "eslint --ext .cjs,.ts .", "format": "prettier --write .", "format:check": "prettier --check .", "doc-hub": "typedoc --tsconfig ../hub/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/hub --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../hub/index.ts", "doc-inference": "typedoc --tsconfig ../inference/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/inference --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../inference/src/index.ts", - "doc-agents": "typedoc --tsconfig ../agents/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/agents --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../agents/src/index.ts", "doc-gguf": "mkdir -p ../../docs/gguf && cp ../../packages/gguf/README.md ../../docs/gguf/README.md", "doc-mcp-client": "mkdir -p ../../docs/mcp-client && cp ../../packages/mcp-client/README.md ../../docs/mcp-client/README.md", + "doc-tiny-agents": "mkdir -p ../../docs/tiny-agents && cp ../../packages/tiny-agents/README.md ../../docs/tiny-agents/README.md", "doc-space-header": "mkdir -p ../../docs/space-header && cp ../../packages/space-header/README.md ../../docs/space-header/README.md", "update-toc": "tsx update-toc.ts", "fix-cdn-versions": "tsx fix-cdn-versions.ts", diff --git a/packages/tiny-agents/README.md b/packages/tiny-agents/README.md index cc15e028bc..d82d6d9cfe 100644 --- a/packages/tiny-agents/README.md +++ b/packages/tiny-agents/README.md @@ -29,6 +29,8 @@ Available Commands: serve Run the Agent as an OpenAI-compatible HTTP server ``` +You can load agents directly from the Hugging Face Hub [tiny-agents](https://huggingface.co/datasets/tiny-agents/tiny-agents) Dataset, or specify a path to your own local agent configuration. + ## Define your own agent The simplest way to create your own agent is to create a folder containing an `agent.json` file: