chore(docs): added AGENTS.MD #106

hawkaii · 2025-09-24T14:12:31Z

What this PR does / why we need it:
adds AGENTS.MD file for AI-assisted development

Fixes #86

Checklist:

Docs included if any changes are user facing

Signed-off-by: Parthib Mukherjee <[email protected]>

kramaranya

Thank you @hawkaii for working on this!

Could we provide more information in this doc to align with other examples?
For example, pipelines have a good content https://github.com/kubeflow/pipelines/blob/master/AGENTS.md
Also kubernetes https://github.com/kubernetes/kubernetes/blob/1f98145048835b8a9fd6ec9d769f57fc548c8304/AGENTS.md
I personally like what langchain has https://github.com/langchain-ai/langchain/blob/master/AGENTS.md

AGENTS.md

…and development principles Signed-off-by: Parthib Mukherjee <[email protected]>

Removed introductory line about AGENTS guide. Signed-off-by: Parthib Mukherjee <[email protected]>

coveralls · 2025-10-16T00:59:21Z

Pull Request Test Coverage Report for Build 18630153766

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
26 unchanged lines in 1 file lost coverage.
Overall coverage increased (+0.7%) to 72.43%

Files with Coverage Reduction	New Missed Lines	%
kubeflow/trainer/utils/utils.py	26	66.06%

Totals
Change from base Build 17979146135:	0.7%
Covered Lines:	310
Relevant Lines:	428

💛 - Coveralls

andreyvelich

Thank you @hawkaii!
Overall looks good, I left a few suggestions.
Maybe @franciscojavierarceo or @kubeflow/wg-pipeline-leads can provide additional suggestions based on their experience in Feast or KFP.

andreyvelich · 2025-10-16T01:03:59Z

AGENTS.md

+## Project Overview
+
+**Purpose**: Kubeflow SDK provides a unified Python SDK for AI practitioners to interact with multiple Kubeflow projects via consistent APIs, focusing on user workflows over infrastructure details.
+
+**Problem It Solves**: Reduces Kubernetes and multi-project complexity, offering simple, local-first Python interfaces for training, tuning, pipelines (planned), and model lifecycle management.
+
+**Key Benefits**:
+- Unified experience across Kubeflow projects
+- Simplified AI workflows with minimal infrastructure knowledge
+- Local development support (install via `pip`) with optional cluster backends
+
+**Today's Scope**:
+- **Available**: Kubeflow Trainer (train/fine-tune with different backends)
+- **Planned**: Katib (HPO), Pipelines (workflows), Model Registry
+- See README "Supported Kubeflow Projects" for current status


Will this help AI Agents to write/debug code or we can remove this to reduce context ?

AGENTS.md

andreyvelich · 2025-10-16T01:07:40Z

AGENTS.md

+- **Available**: Kubeflow Trainer (train/fine-tune with different backends)
+- **Planned**: Katib (HPO), Pipelines (workflows), Model Registry
+- See README "Supported Kubeflow Projects" for current status
+


Might be useful to introduce Context Awareness:

### Context Awareness Before writing code, agents should: - Read docstrings and existing test cases for pattern alignment - Match import patterns from neighboring files - Preserve existing logging and error-handling conventions

andreyvelich · 2025-10-16T01:12:13Z

AGENTS.md

+- **Build**: Hatchling (optional `uv build`)
+- **Pre-commit**: Config provided and enforced in CI
+
+## Quick Start


Wondering if it is better to wrap command to special tokens, like this ?

 Preferred commands: - Install deps: `make install-dev` - Verify: `make verify` - Test: `make test-python`

andreyvelich · 2025-10-16T01:14:23Z

AGENTS.md

+- Use `pytest` as the testing framework
+- See `kubeflow/trainer/test/common.py` for fixtures and patterns
+
+**Test Quality Checklist:**


Tell that unit tests structure must be consistent between each other. As example add: kubeflow/trainer/backends/kubernetes/backend_test.py

andreyvelich · 2025-10-16T01:15:40Z

AGENTS.md

+def test_filter_completed_jobs():
+    """Test filtering completed jobs from a list."""
+    jobs = ["job-1", "job-2", "job-3"]
+    completed = {"job-1", "job-2"}
+
+    result = filter_completed_jobs(jobs, completed)
+
+    assert result == ["job-3"]
+    assert len(result) == 1
+```


Please also show that tests cases must be set before the tests functions with @pytest.mark.parametrize like here:

sdk/kubeflow/trainer/backends/kubernetes/backend_test.py

Line 573 in b471520

@pytest.mark.parametrize(

AGENTS.md

…ment workflow Signed-off-by: Parthib Mukherjee <[email protected]>

franciscojavierarceo · 2025-10-20T13:36:54Z

@andreyvelich i just had claude generate it and i merged it. No discussion :)

franciscojavierarceo · 2025-10-20T13:37:21Z

That was much faster for me. :)

andreyvelich

Thank you @hawkaii!
/lgtm
/assign @Electronic-Waste @kramaranya @szaher @astefanutti

andreyvelich · 2025-10-27T00:29:18Z

We should be good to move this forward.
/approve

google-oss-prow · 2025-10-27T00:29:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [andreyvelich]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

added(AGENTS.MD): added AGENTS.MD

4841ede

Signed-off-by: Parthib Mukherjee <[email protected]>

google-oss-prow bot requested review from kramaranya and szaher September 24, 2025 14:12

google-oss-prow bot added the size/S label Sep 24, 2025

hawkaii changed the title ~~added(AGENTS.MD): added AGENTS.MD~~ chore(AGENTS.MD): added AGENTS.MD Sep 24, 2025

hawkaii changed the title ~~chore(AGENTS.MD): added AGENTS.MD~~ chore(docs): added AGENTS.MD Sep 24, 2025

kramaranya reviewed Sep 29, 2025

View reviewed changes

AGENTS.md Outdated Show resolved Hide resolved

AGENTS.md Outdated Show resolved Hide resolved

docs: Revise AGENTS.md for comprehensive guidance on setup, tooling, …

50dff64

…and development principles Signed-off-by: Parthib Mukherjee <[email protected]>

google-oss-prow bot added size/L and removed size/S labels Sep 29, 2025

Remove introductory line from AGENTS.md

b471520

Removed introductory line about AGENTS guide. Signed-off-by: Parthib Mukherjee <[email protected]>

andreyvelich reviewed Oct 16, 2025

View reviewed changes

docs: Revise AGENTS.md to clarify agent behavior policies and develop…

3a85735

…ment workflow Signed-off-by: Parthib Mukherjee <[email protected]>

andreyvelich reviewed Oct 20, 2025

View reviewed changes

google-oss-prow bot assigned astefanutti, Electronic-Waste, kramaranya, szaher and andreyvelich Oct 20, 2025

google-oss-prow bot added the lgtm label Oct 20, 2025

google-oss-prow bot added the approved label Oct 27, 2025

google-oss-prow bot merged commit e878505 into kubeflow:main Oct 27, 2025
13 of 14 checks passed

google-oss-prow bot added this to the v0.2 milestone Oct 27, 2025

chore(docs): added AGENTS.MD #106

chore(docs): added AGENTS.MD #106

Conversation

hawkaii commented Sep 24, 2025

Uh oh!

kramaranya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coveralls commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 18630153766

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

andreyvelich left a comment

Choose a reason for hiding this comment

Uh oh!

andreyvelich Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andreyvelich Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

andreyvelich Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

andreyvelich Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

andreyvelich Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

franciscojavierarceo commented Oct 20, 2025

Uh oh!

franciscojavierarceo commented Oct 20, 2025

Uh oh!

andreyvelich left a comment

Choose a reason for hiding this comment

Uh oh!

andreyvelich commented Oct 27, 2025

Uh oh!

google-oss-prow bot commented Oct 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

coveralls commented Oct 16, 2025 •

edited

Loading