Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ on:
- "packages/hub/README.md"
- "packages/inference/README.md"
- "packages/agents/README.md"
- "packages/tiny-agents/README.md"
- ".github/workflows/documentation.yml"

jobs:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/pr-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
- "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 }}
Expand Down
7 changes: 6 additions & 1 deletion docs/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@
isExpanded: true
sections:
- local: mcp-client/README
title: Simple MCP Client and smol Agent built on top of Inference Client
title: Simple MCP Client built on top of Inference Client
- title: "@huggingface/tiny-agents"
isExpanded: true
sections:
- local: tiny-agents/README
title: A lightweight MCP-powered Agent built on top of Inference Client
- title: "@huggingface/agent"
isExpanded: true
sections:
Expand Down
3 changes: 2 additions & 1 deletion packages/doc-internal/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"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-agents && 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 .",
Expand All @@ -15,6 +15,7 @@
"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",
Expand Down
2 changes: 2 additions & 0 deletions packages/tiny-agents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading