|
| 1 | +# PineScript Optimizer API Documentation |
| 2 | + |
| 3 | +*Generated: 2026-01-28T01:07:50.057Z* |
| 4 | + |
| 5 | +### Main Class |
| 6 | + |
| 7 | +*File: scripts/pinescript/optimizer.js* |
| 8 | + |
| 9 | +* PineScript Optimizer - Refactored Version |
| 10 | + * |
| 11 | + * Strategy parameter optimization utilities |
| 12 | + * This is a refactored version that delegates to modular components while |
| 13 | + * maintaining 100% backward compatibility with the original API. |
| 14 | + |
| 15 | + |
| 16 | +const OptimizerCore = require('./optimizer-modules/optimizer-core'); |
| 17 | +const ParameterHandler = require('./optimizer-modules/parameter-handler'); |
| 18 | +const OptimizationAlgorithms = require('./optimizer-modules/optimization-algorithms'); |
| 19 | +const AnalysisReporter = require('./optimizer-modules/analysis-reporter'); |
| 20 | + |
| 21 | +/** |
| 22 | + * PineScript Optimizer - Main class for strategy parameter optimization |
| 23 | + * |
| 24 | + * This class delegates to modular components while maintaining 100% backward |
| 25 | + * compatibility with the original API. It provides methods for optimizing |
| 26 | + * PineScript strategy parameters using various optimization algorithms. |
| 27 | + * |
| 28 | + * @class PineOptimizer |
| 29 | + */ |
| 30 | +class PineOptimizer |
| 31 | + |
| 32 | +#### Methods |
| 33 | + |
| 34 | +##### `constructor()` |
| 35 | + |
| 36 | +PineScript Optimizer - Refactored Version |
| 37 | + Strategy parameter optimization utilities |
| 38 | + This is a refactored version that delegates to modular components while |
| 39 | + maintaining 100% backward compatibility with the original API. |
| 40 | + |
| 41 | +##### `detectParameters()` |
| 42 | + |
| 43 | +Detect parameters from strategy file comments |
| 44 | + |
| 45 | +##### `parseParameterSpace()` |
| 46 | + |
| 47 | +Parse parameter space specification |
| 48 | + |
| 49 | +##### `gridSearch()` |
| 50 | + |
| 51 | +Grid search optimization |
| 52 | + |
| 53 | +##### `randomSearch()` |
| 54 | + |
| 55 | +Random search optimization |
| 56 | + |
| 57 | +##### `bayesianOptimization()` |
| 58 | + |
| 59 | +Bayesian optimization |
| 60 | + |
| 61 | +##### `geneticAlgorithm()` |
| 62 | + |
| 63 | +Genetic algorithm optimization |
| 64 | + |
| 65 | +##### `generateGridCombinations()` |
| 66 | + |
| 67 | +Generate grid combinations for parameter space |
| 68 | + |
| 69 | +##### `generateRandomParameters()` |
| 70 | + |
| 71 | +Generate random parameters from parameter space |
| 72 | + |
| 73 | +##### `createParameterizedStrategy()` |
| 74 | + |
| 75 | +Create parameterized strategy file |
| 76 | + |
| 77 | +##### `calculateMetricScore()` |
| 78 | + |
| 79 | +Calculate metric score |
| 80 | + |
| 81 | +##### `analyzeParameterSensitivity()` |
| 82 | + |
| 83 | +Analyze parameter sensitivity |
| 84 | + |
| 85 | +##### `generateOptimizationReport()` |
| 86 | + |
| 87 | +Generate optimization report |
| 88 | + |
| 89 | +##### `generateConsoleOptimizationReport()` |
| 90 | + |
| 91 | +Generate console optimization report |
| 92 | + |
| 93 | +##### `generateHTMLOptimizationReport()` |
| 94 | + |
| 95 | +Generate HTML optimization report |
| 96 | + |
| 97 | +#### Exports |
| 98 | + |
| 99 | +`PineOptimizer` |
| 100 | + |
| 101 | + |
| 102 | +## Modules |
| 103 | + |
| 104 | +### Analysis Reporter |
| 105 | + |
| 106 | +*File: scripts/pinescript/optimizer-modules/analysis-reporter.js* |
| 107 | + |
| 108 | +* Analysis Reporter Module for PineOptimizer |
| 109 | + * |
| 110 | + * Analysis and reporting methods: analyzeParameterSensitivity, generateOptimizationReport, |
| 111 | + * generateConsoleOptimizationReport, generateHTMLOptimizationReport |
| 112 | + |
| 113 | + |
| 114 | +class AnalysisReporter |
| 115 | + |
| 116 | +#### Methods |
| 117 | + |
| 118 | +##### `analyzeParameterSensitivity()` |
| 119 | + |
| 120 | +Analysis Reporter Module for PineOptimizer |
| 121 | + Analysis and reporting methods: analyzeParameterSensitivity, generateOptimizationReport, |
| 122 | + generateConsoleOptimizationReport, generateHTMLOptimizationReport |
| 123 | + |
| 124 | +##### `generateOptimizationReport()` |
| 125 | + |
| 126 | +Generate optimization report |
| 127 | + |
| 128 | +##### `generateConsoleOptimizationReport()` |
| 129 | + |
| 130 | +Generate console optimization report |
| 131 | + |
| 132 | +##### `generateHTMLOptimizationReport()` |
| 133 | + |
| 134 | +Generate HTML optimization report |
| 135 | + |
| 136 | +##### `generateJSONReport()` |
| 137 | + |
| 138 | +Generate JSON report |
| 139 | + |
| 140 | +##### `generateSummaryStatistics()` |
| 141 | + |
| 142 | +Generate summary statistics |
| 143 | + |
| 144 | +##### `exportResultsToCSV()` |
| 145 | + |
| 146 | +Export results to CSV |
| 147 | + |
| 148 | +##### `exportResultsToJSON()` |
| 149 | + |
| 150 | +Export results to JSON |
| 151 | + |
| 152 | +#### Exports |
| 153 | + |
| 154 | +`AnalysisReporter` |
| 155 | + |
| 156 | +### Optimization Algorithms |
| 157 | + |
| 158 | +*File: scripts/pinescript/optimizer-modules/optimization-algorithms.js* |
| 159 | + |
| 160 | +#### Methods |
| 161 | + |
| 162 | +##### `gridSearch()` |
| 163 | + |
| 164 | +Optimization Algorithms Module for PineOptimizer |
| 165 | + Optimization algorithms: gridSearch, randomSearch, bayesianOptimization, geneticAlgorithm |
| 166 | + |
| 167 | +##### `randomSearch()` |
| 168 | + |
| 169 | +Random search optimization |
| 170 | + |
| 171 | +##### `bayesianOptimization()` |
| 172 | + |
| 173 | +Bayesian optimization |
| 174 | + |
| 175 | +##### `geneticAlgorithm()` |
| 176 | + |
| 177 | +Genetic algorithm optimization |
| 178 | + |
| 179 | +##### `evaluateParameters()` |
| 180 | + |
| 181 | +Evaluate parameters by running backtest |
| 182 | + |
| 183 | +##### `calculateMetricScore()` |
| 184 | + |
| 185 | +Calculate metric score |
| 186 | + |
| 187 | +##### `sampleNearParameters()` |
| 188 | + |
| 189 | +Sample parameters near existing parameters |
| 190 | + |
| 191 | +##### `crossover()` |
| 192 | + |
| 193 | +Crossover two parameter sets |
| 194 | + |
| 195 | +##### `mutate()` |
| 196 | + |
| 197 | +Mutate parameters |
| 198 | + |
| 199 | +##### `getAlgorithmDescriptions()` |
| 200 | + |
| 201 | +Get algorithm descriptions |
| 202 | + |
| 203 | +#### Exports |
| 204 | + |
| 205 | +`OptimizationAlgorithms` |
| 206 | + |
| 207 | +### Optimizer Core |
| 208 | + |
| 209 | +*File: scripts/pinescript/optimizer-modules/optimizer-core.js* |
| 210 | + |
| 211 | +#### Methods |
| 212 | + |
| 213 | +##### `optimizeStrategy()` |
| 214 | + |
| 215 | +Optimizer Core Module for PineOptimizer |
| 216 | + Core optimization methods: constructor, optimizeStrategy, detectParameters |
| 217 | + |
| 218 | +##### `detectParameters()` |
| 219 | + |
| 220 | +Detect parameters from strategy file comments |
| 221 | + |
| 222 | +##### `getBacktester()` |
| 223 | + |
| 224 | +Get backtester instance |
| 225 | + |
| 226 | +##### `getProjectPath()` |
| 227 | + |
| 228 | +Get project path |
| 229 | + |
| 230 | +##### `validateOptimizationConfig()` |
| 231 | + |
| 232 | +Validate optimization configuration |
| 233 | + |
| 234 | +##### `getOptimizationMethods()` |
| 235 | + |
| 236 | +Get optimization methods |
| 237 | + |
| 238 | +##### `getOptimizationMetrics()` |
| 239 | + |
| 240 | +Get optimization metrics |
| 241 | + |
| 242 | +#### Exports |
| 243 | + |
| 244 | +`OptimizerCore` |
| 245 | + |
| 246 | +### Parameter Handler |
| 247 | + |
| 248 | +*File: scripts/pinescript/optimizer-modules/parameter-handler.js* |
| 249 | + |
| 250 | +#### Methods |
| 251 | + |
| 252 | +##### `parseParameterSpace()` |
| 253 | + |
| 254 | +Parameter Handler Module for PineOptimizer |
| 255 | + Parameter handling methods: parseParameterSpace, generateGridCombinations, generateRandomParameters, createParameterizedStrategy |
| 256 | + |
| 257 | +##### `generateGridCombinations()` |
| 258 | + |
| 259 | +Generate grid combinations for parameter space |
| 260 | + |
| 261 | +##### `sampleParameterSpace()` |
| 262 | + |
| 263 | +Sample parameter space (for large spaces) |
| 264 | + |
| 265 | +##### `generateRandomParameters()` |
| 266 | + |
| 267 | +Generate random parameters from parameter space |
| 268 | + |
| 269 | +##### `createParameterizedStrategy()` |
| 270 | + |
| 271 | +Create parameterized strategy file |
| 272 | + |
| 273 | +##### `calculateParameterSpaceSize()` |
| 274 | + |
| 275 | +Calculate parameter space size |
| 276 | + |
| 277 | +##### `getParameterStatistics()` |
| 278 | + |
| 279 | +Get parameter statistics |
| 280 | + |
| 281 | +##### `validateParameterSpace()` |
| 282 | + |
| 283 | +Validate parameter space |
| 284 | + |
| 285 | +##### `formatParameterSpace()` |
| 286 | + |
| 287 | +Format parameter space for display |
| 288 | + |
| 289 | +#### Exports |
| 290 | + |
| 291 | +`ParameterHandler` |
| 292 | + |
| 293 | + |
| 294 | +## Usage Examples |
| 295 | + |
| 296 | +For detailed usage examples, see: |
| 297 | +- `docs/examples/QUICK-START-EXAMPLES.md` - Quick start examples |
| 298 | +- `docs/examples/` - Comprehensive examples directory |
| 299 | + |
| 300 | +## Validation |
| 301 | + |
| 302 | +Run validation scripts to ensure module functionality: |
| 303 | +```bash |
| 304 | +node validate-optimizer.js |
| 305 | +``` |
| 306 | + |
| 307 | +## Testing |
| 308 | + |
| 309 | +Run the test suite to verify functionality: |
| 310 | +```bash |
| 311 | +npm test |
| 312 | +``` |
| 313 | + |
0 commit comments