diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000000..47fda80bc0 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,25 @@ +# GitHub Copilot instructions — Amazon SageMaker Python SDK + +Guidance for [GitHub Copilot](https://docs.github.com/en/copilot) working in +**this repository** — the source of the Amazon SageMaker Python SDK. + +This repository keeps its AI-agent guidance in a single source of truth, +[`AGENTS.md`](../AGENTS.md), following the [AGENTS.md](https://agents.md) convention. +Copilot instructions do not support file imports, so **read +[`AGENTS.md`](../AGENTS.md) at the repository root and follow it**. + +Key points from that file (see `AGENTS.md` for the authoritative, complete version): + +- **v3 by default.** The current major version is v3 (`pip install sagemaker`). SDK v3 is a + modular redesign and is **not** backward compatible with v2. Generate v3 patterns in all + example code, docstrings, tests, and docs unless v2 is explicitly in scope. +- **SDK-first.** Use the SageMaker Python SDK v3 as the primary interface (e.g. + `sagemaker.train.ModelTrainer`, `sagemaker.serve.ModelBuilder`); do not drop to raw + `boto3`, the AWS CLI, or hand-rolled scripts unless the SDK genuinely does not cover the + task. +- **No banned v2 patterns** (e.g. `sagemaker.estimator.Estimator`, `estimator.fit(...)`, + framework estimator classes, `sagemaker.model.Model`) in new code. See the v2 → v3 + mapping table in `AGENTS.md` and [`migration.md`](../migration.md). +- **Contributing:** add/update unit tests under `tests/unit/` for code changes, run the + configured formatters/linters, and keep `migration.md` and docstrings consistent for + public API changes. See [`CONTRIBUTING.md`](../CONTRIBUTING.md). diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000000..468086f6bb --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,15 @@ +# CLAUDE.md — Amazon SageMaker Python SDK + +Guidance for [Claude Code](https://docs.anthropic.com/en/docs/claude-code) working in +**this repository** — the source of the Amazon SageMaker Python SDK. + +This repository follows the [AGENTS.md](https://agents.md) convention. To keep a single +source of truth and avoid the two files drifting apart, all guidance lives in +[`AGENTS.md`](./AGENTS.md) and is imported here: + +@AGENTS.md + +For the full guidance — project context, the **v3-by-default** golden rule, banned v2 +patterns and their v3 replacements, the SDK-first interface map, the contributing +workflow, and a canonical v3 train + deploy example — read [`AGENTS.md`](./AGENTS.md) +directly. diff --git a/GEMINI.md b/GEMINI.md new file mode 100644 index 0000000000..2a1f767de5 --- /dev/null +++ b/GEMINI.md @@ -0,0 +1,15 @@ +# GEMINI.md — Amazon SageMaker Python SDK + +Guidance for [Gemini CLI](https://github.com/google-gemini/gemini-cli) working in +**this repository** — the source of the Amazon SageMaker Python SDK. + +This repository follows the [AGENTS.md](https://agents.md) convention. To keep a single +source of truth and avoid the files drifting apart, all guidance lives in +[`AGENTS.md`](./AGENTS.md) and is imported here: + +@AGENTS.md + +For the full guidance — project context, the **v3-by-default** golden rule, banned v2 +patterns and their v3 replacements, the SDK-first interface map, the contributing +workflow, and a canonical v3 train + deploy example — read [`AGENTS.md`](./AGENTS.md) +directly.