Skip to content

Commit 3e3f47c

Browse files
authored
Remove training-agent references and update docs (#180)
1 parent 113a0cf commit 3e3f47c

3 files changed

Lines changed: 27 additions & 76 deletions

File tree

cmd/ome-agent/README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,6 @@ OME-Agent uses subcommands to run specific tasks. Use the following commands:=
181181
```bash
182182
./ome-agent enigma --config <path-to-config.yaml> --debug
183183
```
184-
```bash
185-
./ome-agent training-agent --config <path-to-config.yaml> --debug
186-
```
187184

188185

189186
## Development Guide
@@ -203,7 +200,6 @@ make push-ome-agent-image
203200
make run-ome-agent-enigma
204201
make run-ome-agent-hf-download
205202
make run-ome-agent-os-replica
206-
make run-ome-agent-training-agent
207203
```
208204

209205
### Code Structure
@@ -214,23 +210,28 @@ OME-Agent follows a modular and scalable design, which makes it easy to extend w
214210

215211
The main directory layout might look something like this:
216212
```
217-
ome-agent/
218-
├── cmd/ # Contains Cobra subcommands
219-
│ ├──main.go # Main entry point for the CLI
220-
│ ├── hf_download_agent.go # Subcommand for HuggingFace model downloads
221-
│ ├── enigma_agent.go # Subcommand for model encryption/decryption
222-
│ ├── replica_agent.go # Subcommand for object storage replication
223-
│ └── training_agent.go # Subcommand for training sidecar agent
224-
├── internal/ # Contains the core business logic for each feature
225-
│ ├── enigma/ # Logic for encryption/decryption
226-
│ ├── replica/ # Logic for replication across OCI buckets
227-
│ └── training-agent/ # Logic for training sidecar agent
228-
├── pkg/ # Shared libraries and utility functions
229-
│ ├── configutils/ # Utility functions for handling configuration files
230-
│ ├── constants/ # Common constants used across the project
231-
│ ├── logging/ # Logging module for consistent logging across commands
232-
│ ├── secrets/ # Secret management (e.g., KMS integration for decryption)
233-
│ └── hf_download/ # Logic for HuggingFace downloading (independent enough to be its own package)
213+
ome/
214+
├── cmd/ # Contains subbinaries
215+
│ └── ome-agent/ # Contains Cobra subcommands
216+
│ ├── main.go # Main entry point for the CLI
217+
│ ├── hf_download_agent.go # Subcommand for HuggingFace model downloads
218+
│ ├── enigma_agent.go # Subcommand for model encryption/decryption
219+
│ ├── model_metadata_agent.go # Subcommand for model metadata extraction
220+
│ ├── replica_agent.go # Subcommand for object storage replication
221+
│ └── serving_agent.go # Subcommand for serving sidecar agent
222+
│ └── fine-tuned-adapter.go # Subcommand for fine-tuned adapter
223+
├── internal/ # Contains the core business logic for each feature
224+
│ ├── enigma/ # Logic for encryption/decryption
225+
│ ├── fine-tuned-adapter/ # Logic for fine-tuned adapter
226+
│ ├── model-metadata/ # Logic for model metadata extraction
227+
│ ├── replica/ # Logic for replication across OCI buckets
228+
│ └── serving-agent/ # Logic for serving sidecar agent
229+
├── pkg/ # Shared libraries and utility functions
230+
│ ├── configutils/ # Utility functions for handling configuration files
231+
│ ├── constants/ # Common constants used across the project
232+
│ ├── logging/ # Logging module for consistent logging across commands
233+
│ ├── secrets/ # Secret management (e.g., KMS integration for decryption)
234+
│ └── hf_download/ # Logic for HuggingFace downloading (independent enough to be its own package)
234235
```
235236

236237
### Key Components Explained

tests/agent_integration_test.go

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,14 @@ var _ = Describe("OME Agent Framework", Ordered, func() {
6363

6464
// Check for all agent commands
6565
TestLogger.Info("Verifying help output contains all agent commands")
66+
Expect(stdout).To(ContainSubstring("completion"))
6667
Expect(stdout).To(ContainSubstring("enigma"))
68+
Expect(stdout).To(ContainSubstring("fine-tuned-adapter"))
69+
Expect(stdout).To(ContainSubstring("help"))
6770
Expect(stdout).To(ContainSubstring("hf-download"))
71+
Expect(stdout).To(ContainSubstring("model-metadata"))
6872
Expect(stdout).To(ContainSubstring("replica"))
69-
Expect(stdout).To(ContainSubstring("training-agent"))
7073
Expect(stdout).To(ContainSubstring("serving-agent"))
71-
Expect(stdout).To(ContainSubstring("fine-tuned-adapter"))
7274
})
7375

7476
// Version flag test removed as it might not be implemented
@@ -105,16 +107,6 @@ var _ = Describe("OME Agent Framework", Ordered, func() {
105107
Expect(stdout).To(ContainSubstring("--debug"))
106108
})
107109

108-
It("should display the training-agent help", func() {
109-
stdout, stderr, err := RunAgent(binaryPath, "training-agent", "--help")
110-
Expect(err).NotTo(HaveOccurred())
111-
Expect(stderr).To(BeEmpty())
112-
113-
Expect(stdout).To(ContainSubstring("OME Training Agent"))
114-
Expect(stdout).To(ContainSubstring("--config"))
115-
Expect(stdout).To(ContainSubstring("--debug"))
116-
})
117-
118110
It("should display the serving-agent help", func() {
119111
stdout, stderr, err := RunAgent(binaryPath, "serving-agent", "--help")
120112
Expect(err).NotTo(HaveOccurred())
@@ -158,13 +150,6 @@ var _ = Describe("OME Agent Framework", Ordered, func() {
158150
Expect(stderr).To(ContainSubstring("no config file provided"))
159151
})
160152

161-
It("should report an error for training-agent", func() {
162-
_, stderr, err := RunAgent(binaryPath, "training-agent")
163-
164-
Expect(err).To(HaveOccurred())
165-
Expect(stderr).To(ContainSubstring("no config file provided"))
166-
})
167-
168153
It("should report an error for serving-agent", func() {
169154
_, stderr, err := RunAgent(binaryPath, "serving-agent")
170155

@@ -306,7 +291,6 @@ debug: false
306291
"enigma",
307292
"hf-download",
308293
"replica",
309-
"training-agent",
310294
"serving-agent",
311295
"fine-tuned-adapter",
312296
}
@@ -378,15 +362,6 @@ output: ` + mockDataDir + `/output
378362
Expect(stdout).To(ContainSubstring("Replica agent started"))
379363
})
380364

381-
XIt("should start the training-agent", func() {
382-
stdout, _, err := RunAgent(binaryPath, "training-agent", "--config", configPaths["training-agent"])
383-
384-
// In a real test, you would need to mock the dependencies
385-
// This is just an example of how to structure the test
386-
Expect(err).NotTo(HaveOccurred())
387-
Expect(stdout).To(ContainSubstring("Training agent started"))
388-
})
389-
390365
XIt("should start the serving-agent", func() {
391366
stdout, _, err := RunAgent(binaryPath, "serving-agent", "--config", configPaths["serving-agent"])
392367

tests/helpers.go

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -158,17 +158,7 @@ destination:
158158
bucket: dest-bucket
159159
region: us-east-1
160160
`
161-
case "training-agent":
162-
content = `
163-
debug: true
164-
# Mock training agent config
165-
model_path: /path/to/model
166-
batch_size: 32
167-
auth_type: instance_principal
168-
input_object_store:
169-
bucket: input-bucket
170-
region: us-west-2
171-
`
161+
172162
case "serving-agent":
173163
content = `
174164
debug: true
@@ -240,21 +230,6 @@ destination:
240230
temp_dir: %s
241231
`, mockDataDir)
242232

243-
case "training-agent":
244-
content = fmt.Sprintf(`
245-
debug: true
246-
# Detailed mock training agent config
247-
model_path: %s/model
248-
batch_size: 32
249-
epochs: 3
250-
learning_rate: 0.001
251-
auth_type: instance_principal
252-
input_object_store:
253-
bucket: input-bucket
254-
region: us-west-2
255-
namespace: mock-namespace
256-
`, mockDataDir)
257-
258233
case "serving-agent":
259234
content = fmt.Sprintf(`
260235
debug: true

0 commit comments

Comments
 (0)