Sovereign_Map_Federated_Learning/docs/api/openapi.training.yaml at main · rwilliamspbg-ops/Sovereign_Map_Federated_Learning · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
openapi: 3.0.3
info:
  title: Sovereign Map Phase 3D Training Service API
  version: 3.0.0
  description: API exposed by packages/training/api.py
servers:
  - url: http://localhost:5001
    description: Local phase 3D training backend

tags:
  - name: TrainingService

paths:
  /health:
    get:
      tags: [TrainingService]
      summary: Health check
      operationId: getTrainingServiceHealth
      responses:
        '200':
          description: Service health
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

  /training/config:
    get:
      tags: [TrainingService]
      summary: Get training config
      operationId: getTrainingConfig
      responses:
        '200':
          description: Current training configuration
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
    post:
      tags: [TrainingService]
      summary: Set training config
      operationId: postTrainingConfig
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Configuration accepted
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Invalid configuration
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

  /training/start:
    post:
      tags: [TrainingService]
      summary: Start training job
      operationId: postTrainingStart
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Training started
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Training cannot be started
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

  /training/status:
    get:
      tags: [TrainingService]
      summary: Get training status
      operationId: getTrainingStatus
      responses:
        '200':
          description: Training status payload
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

  /training/metrics:
    get:
      tags: [TrainingService]
      summary: Get collected metrics history
      operationId: getTrainingMetrics
      responses:
        '200':
          description: Metrics history
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

  /training/metrics_summary:
    get:
      tags: [TrainingService]
      summary: Get latest compact metrics summary
      operationId: getTrainingMetricsSummary
      responses:
        '200':
          description: Summary metrics
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

  /training/cancel:
    post:
      tags: [TrainingService]
      summary: Cancel ongoing training
      operationId: postTrainingCancel
      responses:
        '200':
          description: Training cancelled
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: No active training to cancel
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

  /training/history:
    get:
      tags: [TrainingService]
      summary: Get full training history
      operationId: getTrainingHistory
      responses:
        '200':
          description: Training history payload
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true

  /training/export:
    get:
      tags: [TrainingService]
      summary: Export training history to file
      operationId: getTrainingExport
      responses:
        '200':
          description: Export result
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true