Commit
·
4a5dfa2
1
Parent(s):
3924853
adding integration docs
Browse files- docs/integrate.md +66 -0
docs/integrate.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
GET /health
|
| 3 |
+
|
| 4 |
+
Response:
|
| 5 |
+
|
| 6 |
+
{
|
| 7 |
+
"status": "healthy",
|
| 8 |
+
"timestamp": "2025-11-25T00:17:15.053513",
|
| 9 |
+
"service": "greedyoptim-api"
|
| 10 |
+
}
|
| 11 |
+
|
| 12 |
+
|
| 13 |
+
GET /methods
|
| 14 |
+
|
| 15 |
+
Response:
|
| 16 |
+
|
| 17 |
+
{
|
| 18 |
+
"available_methods": {
|
| 19 |
+
"ga": {
|
| 20 |
+
"name": "Genetic Algorithm",
|
| 21 |
+
"description": "Evolutionary optimization using selection, crossover, and mutation",
|
| 22 |
+
"typical_time": "medium",
|
| 23 |
+
"solution_quality": "high"
|
| 24 |
+
},
|
| 25 |
+
"cmaes": {
|
| 26 |
+
"name": "CMA-ES",
|
| 27 |
+
"description": "Covariance Matrix Adaptation Evolution Strategy",
|
| 28 |
+
"typical_time": "medium-high",
|
| 29 |
+
"solution_quality": "very high"
|
| 30 |
+
},
|
| 31 |
+
"pso": {
|
| 32 |
+
"name": "Particle Swarm Optimization",
|
| 33 |
+
"description": "Swarm intelligence-based optimization",
|
| 34 |
+
"typical_time": "medium",
|
| 35 |
+
"solution_quality": "high"
|
| 36 |
+
},
|
| 37 |
+
"sa": {
|
| 38 |
+
"name": "Simulated Annealing",
|
| 39 |
+
"description": "Probabilistic optimization inspired by metallurgy",
|
| 40 |
+
"typical_time": "medium",
|
| 41 |
+
"solution_quality": "medium-high"
|
| 42 |
+
},
|
| 43 |
+
"nsga2": {
|
| 44 |
+
"name": "NSGA-II",
|
| 45 |
+
"description": "Non-dominated Sorting Genetic Algorithm (multi-objective)",
|
| 46 |
+
"typical_time": "high",
|
| 47 |
+
"solution_quality": "very high"
|
| 48 |
+
},
|
| 49 |
+
"adaptive": {
|
| 50 |
+
"name": "Adaptive Optimizer",
|
| 51 |
+
"description": "Automatically selects best algorithm",
|
| 52 |
+
"typical_time": "high",
|
| 53 |
+
"solution_quality": "very high"
|
| 54 |
+
},
|
| 55 |
+
"ensemble": {
|
| 56 |
+
"name": "Ensemble Optimizer",
|
| 57 |
+
"description": "Runs multiple algorithms in parallel",
|
| 58 |
+
"typical_time": "high",
|
| 59 |
+
"solution_quality": "highest"
|
| 60 |
+
}
|
| 61 |
+
},
|
| 62 |
+
"default_method": "ga",
|
| 63 |
+
"recommended_for_speed": "ga",
|
| 64 |
+
"recommended_for_quality": "ensemble"
|
| 65 |
+
}
|
| 66 |
+
|