summaryrefslogtreecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/ml/param/Params.html
blob: ba5edb8f909dc1c27d686aae0e81889aa3c9fd7e (plain) (blame)
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_51) on Wed Sep 16 15:55:12 PDT 2015 -->
<title>Params</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Params";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/param/ParamValidators.html" title="class in org.apache.spark.ml.param"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/param/Params.html" target="_top">Frames</a></li>
<li><a href="Params.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.spark.ml.param</div>
<h2 title="Interface Params" class="title">Interface Params</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a>, java.io.Serializable</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/spark/ml/recommendation/ALS.html" title="class in org.apache.spark.ml.recommendation">ALS</a>, <a href="../../../../../org/apache/spark/ml/recommendation/ALSModel.html" title="class in org.apache.spark.ml.recommendation">ALSModel</a>, <a href="../../../../../org/apache/spark/ml/feature/Binarizer.html" title="class in org.apache.spark.ml.feature">Binarizer</a>, <a href="../../../../../org/apache/spark/ml/evaluation/BinaryClassificationEvaluator.html" title="class in org.apache.spark.ml.evaluation">BinaryClassificationEvaluator</a>, <a href="../../../../../org/apache/spark/ml/feature/Bucketizer.html" title="class in org.apache.spark.ml.feature">Bucketizer</a>, <a href="../../../../../org/apache/spark/ml/classification/ClassificationModel.html" title="class in org.apache.spark.ml.classification">ClassificationModel</a>, <a href="../../../../../org/apache/spark/ml/classification/Classifier.html" title="class in org.apache.spark.ml.classification">Classifier</a>, <a href="../../../../../org/apache/spark/ml/feature/ColumnPruner.html" title="class in org.apache.spark.ml.feature">ColumnPruner</a>, <a href="../../../../../org/apache/spark/ml/feature/CountVectorizer.html" title="class in org.apache.spark.ml.feature">CountVectorizer</a>, <a href="../../../../../org/apache/spark/ml/feature/CountVectorizerModel.html" title="class in org.apache.spark.ml.feature">CountVectorizerModel</a>, <a href="../../../../../org/apache/spark/ml/tuning/CrossValidator.html" title="class in org.apache.spark.ml.tuning">CrossValidator</a>, <a href="../../../../../org/apache/spark/ml/tuning/CrossValidatorModel.html" title="class in org.apache.spark.ml.tuning">CrossValidatorModel</a>, <a href="../../../../../org/apache/spark/ml/feature/DCT.html" title="class in org.apache.spark.ml.feature">DCT</a>, <a href="../../../../../org/apache/spark/ml/classification/DecisionTreeClassificationModel.html" title="class in org.apache.spark.ml.classification">DecisionTreeClassificationModel</a>, <a href="../../../../../org/apache/spark/ml/classification/DecisionTreeClassifier.html" title="class in org.apache.spark.ml.classification">DecisionTreeClassifier</a>, <a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>, <a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressor.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressor</a>, <a href="../../../../../org/apache/spark/ml/feature/ElementwiseProduct.html" title="class in org.apache.spark.ml.feature">ElementwiseProduct</a>, <a href="../../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">Estimator</a>, <a href="../../../../../org/apache/spark/ml/evaluation/Evaluator.html" title="class in org.apache.spark.ml.evaluation">Evaluator</a>, <a href="../../../../../org/apache/spark/ml/classification/GBTClassificationModel.html" title="class in org.apache.spark.ml.classification">GBTClassificationModel</a>, <a href="../../../../../org/apache/spark/ml/classification/GBTClassifier.html" title="class in org.apache.spark.ml.classification">GBTClassifier</a>, <a href="../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html" title="class in org.apache.spark.ml.regression">GBTRegressionModel</a>, <a href="../../../../../org/apache/spark/ml/regression/GBTRegressor.html" title="class in org.apache.spark.ml.regression">GBTRegressor</a>, <a href="../../../../../org/apache/spark/ml/feature/HashingTF.html" title="class in org.apache.spark.ml.feature">HashingTF</a>, <a href="../../../../../org/apache/spark/ml/feature/IDF.html" title="class in org.apache.spark.ml.feature">IDF</a>, <a href="../../../../../org/apache/spark/ml/feature/IDFModel.html" title="class in org.apache.spark.ml.feature">IDFModel</a>, <a href="../../../../../org/apache/spark/ml/feature/IndexToString.html" title="class in org.apache.spark.ml.feature">IndexToString</a>, <a href="../../../../../org/apache/spark/ml/regression/IsotonicRegression.html" title="class in org.apache.spark.ml.regression">IsotonicRegression</a>, <a href="../../../../../org/apache/spark/ml/regression/IsotonicRegressionModel.html" title="class in org.apache.spark.ml.regression">IsotonicRegressionModel</a>, <a href="../../../../../org/apache/spark/ml/param/JavaParams.html" title="class in org.apache.spark.ml.param">JavaParams</a>, <a href="../../../../../org/apache/spark/ml/clustering/KMeans.html" title="class in org.apache.spark.ml.clustering">KMeans</a>, <a href="../../../../../org/apache/spark/ml/clustering/KMeansModel.html" title="class in org.apache.spark.ml.clustering">KMeansModel</a>, <a href="../../../../../org/apache/spark/ml/regression/LinearRegression.html" title="class in org.apache.spark.ml.regression">LinearRegression</a>, <a href="../../../../../org/apache/spark/ml/regression/LinearRegressionModel.html" title="class in org.apache.spark.ml.regression">LinearRegressionModel</a>, <a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a>, <a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification">LogisticRegressionModel</a>, <a href="../../../../../org/apache/spark/ml/feature/MinMaxScaler.html" title="class in org.apache.spark.ml.feature">MinMaxScaler</a>, <a href="../../../../../org/apache/spark/ml/feature/MinMaxScalerModel.html" title="class in org.apache.spark.ml.feature">MinMaxScalerModel</a>, <a href="../../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">Model</a>, <a href="../../../../../org/apache/spark/ml/evaluation/MulticlassClassificationEvaluator.html" title="class in org.apache.spark.ml.evaluation">MulticlassClassificationEvaluator</a>, <a href="../../../../../org/apache/spark/ml/classification/MultilayerPerceptronClassificationModel.html" title="class in org.apache.spark.ml.classification">MultilayerPerceptronClassificationModel</a>, <a href="../../../../../org/apache/spark/ml/classification/MultilayerPerceptronClassifier.html" title="class in org.apache.spark.ml.classification">MultilayerPerceptronClassifier</a>, <a href="../../../../../org/apache/spark/ml/classification/NaiveBayes.html" title="class in org.apache.spark.ml.classification">NaiveBayes</a>, <a href="../../../../../org/apache/spark/ml/classification/NaiveBayesModel.html" title="class in org.apache.spark.ml.classification">NaiveBayesModel</a>, <a href="../../../../../org/apache/spark/ml/feature/NGram.html" title="class in org.apache.spark.ml.feature">NGram</a>, <a href="../../../../../org/apache/spark/ml/feature/Normalizer.html" title="class in org.apache.spark.ml.feature">Normalizer</a>, <a href="../../../../../org/apache/spark/ml/feature/OneHotEncoder.html" title="class in org.apache.spark.ml.feature">OneHotEncoder</a>, <a href="../../../../../org/apache/spark/ml/classification/OneVsRest.html" title="class in org.apache.spark.ml.classification">OneVsRest</a>, <a href="../../../../../org/apache/spark/ml/classification/OneVsRestModel.html" title="class in org.apache.spark.ml.classification">OneVsRestModel</a>, <a href="../../../../../org/apache/spark/ml/feature/PCA.html" title="class in org.apache.spark.ml.feature">PCA</a>, <a href="../../../../../org/apache/spark/ml/feature/PCAModel.html" title="class in org.apache.spark.ml.feature">PCAModel</a>, <a href="../../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a>, <a href="../../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml">PipelineModel</a>, <a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a>, <a href="../../../../../org/apache/spark/ml/feature/PolynomialExpansion.html" title="class in org.apache.spark.ml.feature">PolynomialExpansion</a>, <a href="../../../../../org/apache/spark/ml/PredictionModel.html" title="class in org.apache.spark.ml">PredictionModel</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html" title="class in org.apache.spark.ml">Predictor</a>, <a href="../../../../../org/apache/spark/ml/classification/ProbabilisticClassificationModel.html" title="class in org.apache.spark.ml.classification">ProbabilisticClassificationModel</a>, <a href="../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html" title="class in org.apache.spark.ml.classification">ProbabilisticClassifier</a>, <a href="../../../../../org/apache/spark/ml/classification/RandomForestClassificationModel.html" title="class in org.apache.spark.ml.classification">RandomForestClassificationModel</a>, <a href="../../../../../org/apache/spark/ml/classification/RandomForestClassifier.html" title="class in org.apache.spark.ml.classification">RandomForestClassifier</a>, <a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>, <a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressor.html" title="class in org.apache.spark.ml.regression">RandomForestRegressor</a>, <a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>, <a href="../../../../../org/apache/spark/ml/evaluation/RegressionEvaluator.html" title="class in org.apache.spark.ml.evaluation">RegressionEvaluator</a>, <a href="../../../../../org/apache/spark/ml/regression/RegressionModel.html" title="class in org.apache.spark.ml.regression">RegressionModel</a>, <a href="../../../../../org/apache/spark/ml/feature/RFormula.html" title="class in org.apache.spark.ml.feature">RFormula</a>, <a href="../../../../../org/apache/spark/ml/feature/RFormulaModel.html" title="class in org.apache.spark.ml.feature">RFormulaModel</a>, <a href="../../../../../org/apache/spark/ml/feature/StandardScaler.html" title="class in org.apache.spark.ml.feature">StandardScaler</a>, <a href="../../../../../org/apache/spark/ml/feature/StandardScalerModel.html" title="class in org.apache.spark.ml.feature">StandardScalerModel</a>, <a href="../../../../../org/apache/spark/ml/feature/StopWordsRemover.html" title="class in org.apache.spark.ml.feature">StopWordsRemover</a>, <a href="../../../../../org/apache/spark/ml/feature/StringIndexer.html" title="class in org.apache.spark.ml.feature">StringIndexer</a>, <a href="../../../../../org/apache/spark/ml/feature/StringIndexerModel.html" title="class in org.apache.spark.ml.feature">StringIndexerModel</a>, <a href="../../../../../org/apache/spark/ml/feature/Tokenizer.html" title="class in org.apache.spark.ml.feature">Tokenizer</a>, <a href="../../../../../org/apache/spark/ml/tuning/TrainValidationSplit.html" title="class in org.apache.spark.ml.tuning">TrainValidationSplit</a>, <a href="../../../../../org/apache/spark/ml/tuning/TrainValidationSplitModel.html" title="class in org.apache.spark.ml.tuning">TrainValidationSplitModel</a>, <a href="../../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">Transformer</a>, <a href="../../../../../org/apache/spark/ml/UnaryTransformer.html" title="class in org.apache.spark.ml">UnaryTransformer</a>, <a href="../../../../../org/apache/spark/ml/feature/VectorAssembler.html" title="class in org.apache.spark.ml.feature">VectorAssembler</a>, <a href="../../../../../org/apache/spark/ml/feature/VectorIndexer.html" title="class in org.apache.spark.ml.feature">VectorIndexer</a>, <a href="../../../../../org/apache/spark/ml/feature/VectorIndexerModel.html" title="class in org.apache.spark.ml.feature">VectorIndexerModel</a>, <a href="../../../../../org/apache/spark/ml/feature/VectorSlicer.html" title="class in org.apache.spark.ml.feature">VectorSlicer</a>, <a href="../../../../../org/apache/spark/ml/feature/Word2Vec.html" title="class in org.apache.spark.ml.feature">Word2Vec</a>, <a href="../../../../../org/apache/spark/ml/feature/Word2VecModel.html" title="class in org.apache.spark.ml.feature">Word2VecModel</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Params</span>
extends <a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a>, scala.Serializable</pre>
<div class="block">:: DeveloperApi ::
 Trait for components that take parameters. This also provides an internal param map to store
 parameter values attached to the instance.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#clear(org.apache.spark.ml.param.Param)">clear</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</code>
<div class="block">Clears the user-supplied value for the input param.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#copy(org.apache.spark.ml.param.ParamMap)">copy</a></strong>(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</code>
<div class="block">Creates a copy of this instance with the same UID and some extra params.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&gt;&nbsp;<br>T</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#copyValues(T, org.apache.spark.ml.param.ParamMap)">copyValues</a></strong>(T&nbsp;to,
          <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</code>
<div class="block">Copies param values from this instance to another instance for params shared by them.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&gt;&nbsp;<br>T</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#defaultCopy(org.apache.spark.ml.param.ParamMap)">defaultCopy</a></strong>(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</code>
<div class="block">Default implementation of copy with extra params.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap()">defaultParamMap</a></strong>()</code>
<div class="block">Internal param map for default values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#explainParam(org.apache.spark.ml.param.Param)">explainParam</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</code>
<div class="block">Explains a param.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#explainParams()">explainParams</a></strong>()</code>
<div class="block">Explains all params of this instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap()">extractParamMap</a></strong>()</code>
<div class="block"><code>extractParamMap</code> with no extra values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap(org.apache.spark.ml.param.ParamMap)">extractParamMap</a></strong>(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</code>
<div class="block">Extracts the embedded default param values and user-supplied values, and then merges them with
 extra values from input into a flat param map, where the latter value is used if there exist
 conflicts, i.e., with ordering: default param values < user-supplied values < extra.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;scala.Option&lt;T&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#get(org.apache.spark.ml.param.Param)">get</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param)</code>
<div class="block">Optionally returns the user-supplied value of a param.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;scala.Option&lt;T&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#getDefault(org.apache.spark.ml.param.Param)">getDefault</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param)</code>
<div class="block">Gets the default value of a parameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#getOrDefault(org.apache.spark.ml.param.Param)">getOrDefault</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param)</code>
<div class="block">Gets the value of a param in the embedded param map or its default value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#getParam(java.lang.String)">getParam</a></strong>(java.lang.String&nbsp;paramName)</code>
<div class="block">Gets a param by its name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#hasDefault(org.apache.spark.ml.param.Param)">hasDefault</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param)</code>
<div class="block">Tests whether the input param has a default value set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#hasParam(java.lang.String)">hasParam</a></strong>(java.lang.String&nbsp;paramName)</code>
<div class="block">Tests whether this instance contains a param with a given name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#isDefined(org.apache.spark.ml.param.Param)">isDefined</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</code>
<div class="block">Checks whether a param is explicitly set or has a default value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#isSet(org.apache.spark.ml.param.Param)">isSet</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</code>
<div class="block">Checks whether a param is explicitly set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#paramMap()">paramMap</a></strong>()</code>
<div class="block">Internal param map for user-supplied values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#params()">params</a></strong>()</code>
<div class="block">Returns all params sorted by their names.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#set(org.apache.spark.ml.param.Param, T)">set</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param,
   T&nbsp;value)</code>
<div class="block">Sets a parameter in the embedded param map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#set(org.apache.spark.ml.param.ParamPair)">set</a></strong>(<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a>&lt;?&gt;&nbsp;paramPair)</code>
<div class="block">Sets a parameter in the embedded param map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#set(java.lang.String, java.lang.Object)">set</a></strong>(java.lang.String&nbsp;param,
   java.lang.Object&nbsp;value)</code>
<div class="block">Sets a parameter (by name) in the embedded param map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault(org.apache.spark.ml.param.Param, T)">setDefault</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param,
          T&nbsp;value)</code>
<div class="block">Sets a default value for a param.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault(scala.collection.Seq)">setDefault</a></strong>(scala.collection.Seq&lt;<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a>&lt;?&gt;&gt;&nbsp;paramPairs)</code>
<div class="block">Sets default values for a list of params.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#shouldOwn(org.apache.spark.ml.param.Param)">shouldOwn</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</code>
<div class="block">Validates that the input param belongs to this instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/param/Params.html#validateParams()">validateParams</a></strong>()</code>
<div class="block">Validates parameter values stored internally.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.ml.util.Identifiable">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.util.<a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></h3>
<code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#toString()">toString</a>, <a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid()">uid</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="params()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>params</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;[]&nbsp;params()</pre>
<div class="block">Returns all params sorted by their names. The default implementation uses Java reflection to
 list all public methods that have no arguments and return <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param"><code>Param</code></a>.
 <p>
 Note: Developer should not use this method in constructor because we cannot guarantee that
 this variable gets initialized before other params.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="validateParams()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateParams</h4>
<pre>void&nbsp;validateParams()</pre>
<div class="block">Validates parameter values stored internally.
 Raise an exception if any parameter value is invalid.
 <p>
 This only needs to check for interactions between parameters.
 Parameter value checks which do not depend on other parameters are handled by
 <code>Param.validate()</code>.  This method does not handle input/output column parameters;
 those are checked during schema validation.</div>
</li>
</ul>
<a name="explainParam(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explainParam</h4>
<pre>java.lang.String&nbsp;explainParam(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</pre>
<div class="block">Explains a param.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - input param, must belong to this instance.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a string that contains the input param name, doc, and optionally its default value and
         the user-supplied value</dd></dl>
</li>
</ul>
<a name="explainParams()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explainParams</h4>
<pre>java.lang.String&nbsp;explainParams()</pre>
<div class="block">Explains all params of this instance.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd><dt><span class="strong">See Also:</span></dt><dd><code>explainParam()</code></dd></dl>
</li>
</ul>
<a name="isSet(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSet</h4>
<pre>boolean&nbsp;isSet(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</pre>
<div class="block">Checks whether a param is explicitly set.</div>
</li>
</ul>
<a name="isDefined(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDefined</h4>
<pre>boolean&nbsp;isDefined(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</pre>
<div class="block">Checks whether a param is explicitly set or has a default value.</div>
</li>
</ul>
<a name="hasParam(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasParam</h4>
<pre>boolean&nbsp;hasParam(java.lang.String&nbsp;paramName)</pre>
<div class="block">Tests whether this instance contains a param with a given name.</div>
</li>
</ul>
<a name="getParam(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParam</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;java.lang.Object&gt;&nbsp;getParam(java.lang.String&nbsp;paramName)</pre>
<div class="block">Gets a param by its name.</div>
</li>
</ul>
<a name="set(org.apache.spark.ml.param.Param,java.lang.Object)">
<!--   -->
</a><a name="set(org.apache.spark.ml.param.Param, T)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&nbsp;set(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param,
             T&nbsp;value)</pre>
<div class="block">Sets a parameter in the embedded param map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="set(java.lang.String, java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&nbsp;set(java.lang.String&nbsp;param,
         java.lang.Object&nbsp;value)</pre>
<div class="block">Sets a parameter (by name) in the embedded param map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="set(org.apache.spark.ml.param.ParamPair)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&nbsp;set(<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a>&lt;?&gt;&nbsp;paramPair)</pre>
<div class="block">Sets a parameter in the embedded param map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paramPair</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="get(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>&lt;T&gt;&nbsp;scala.Option&lt;T&gt;&nbsp;get(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param)</pre>
<div class="block">Optionally returns the user-supplied value of a param.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="clear(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&nbsp;clear(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</pre>
<div class="block">Clears the user-supplied value for the input param.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="getOrDefault(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrDefault</h4>
<pre>&lt;T&gt;&nbsp;T&nbsp;getOrDefault(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param)</pre>
<div class="block">Gets the value of a param in the embedded param map or its default value. Throws an exception
 if neither is set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setDefault(org.apache.spark.ml.param.Param,java.lang.Object)">
<!--   -->
</a><a name="setDefault(org.apache.spark.ml.param.Param, T)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefault</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&nbsp;setDefault(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param,
                    T&nbsp;value)</pre>
<div class="block">Sets a default value for a param.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - param to set the default value. Make sure that this param is initialized before
               this method gets called.</dd><dd><code>value</code> - the default value</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setDefault(scala.collection.Seq)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefault</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&nbsp;setDefault(scala.collection.Seq&lt;<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a>&lt;?&gt;&gt;&nbsp;paramPairs)</pre>
<div class="block">Sets default values for a list of params.
 <p>
 Note: Java developers should use the single-parameter <code>setDefault()</code>.
       Annotating this with varargs can cause compilation failures due to a Scala compiler bug.
       See SPARK-9268.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paramPairs</code> - a list of param pairs that specify params and their default values to set
                    respectively. Make sure that the params are initialized before this method
                    gets called.</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="getDefault(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefault</h4>
<pre>&lt;T&gt;&nbsp;scala.Option&lt;T&gt;&nbsp;getDefault(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param)</pre>
<div class="block">Gets the default value of a parameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="hasDefault(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasDefault</h4>
<pre>&lt;T&gt;&nbsp;boolean&nbsp;hasDefault(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;T&gt;&nbsp;param)</pre>
<div class="block">Tests whether the input param has a default value set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="copy(org.apache.spark.ml.param.ParamMap)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&nbsp;copy(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</pre>
<div class="block">Creates a copy of this instance with the same UID and some extra params.
 Subclasses should implement this method and set the return type properly.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>extra</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd><dt><span class="strong">See Also:</span></dt><dd><code>defaultCopy()</code></dd></dl>
</li>
</ul>
<a name="defaultCopy(org.apache.spark.ml.param.ParamMap)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultCopy</h4>
<pre>&lt;T extends <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&gt;&nbsp;T&nbsp;defaultCopy(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</pre>
<div class="block">Default implementation of copy with extra params.
 It tries to create a new instance with the same UID.
 Then it copies the embedded and extra parameters over and returns the new instance.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>extra</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="extractParamMap(org.apache.spark.ml.param.ParamMap)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractParamMap</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extractParamMap(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</pre>
<div class="block">Extracts the embedded default param values and user-supplied values, and then merges them with
 extra values from input into a flat param map, where the latter value is used if there exist
 conflicts, i.e., with ordering: default param values < user-supplied values < extra.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>extra</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="extractParamMap()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractParamMap</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extractParamMap()</pre>
<div class="block"><code>extractParamMap</code> with no extra values.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="paramMap()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paramMap</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;paramMap()</pre>
<div class="block">Internal param map for user-supplied values.</div>
</li>
</ul>
<a name="defaultParamMap()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultParamMap</h4>
<pre><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;defaultParamMap()</pre>
<div class="block">Internal param map for default values.</div>
</li>
</ul>
<a name="shouldOwn(org.apache.spark.ml.param.Param)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldOwn</h4>
<pre>void&nbsp;shouldOwn(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;?&gt;&nbsp;param)</pre>
<div class="block">Validates that the input param belongs to this instance.</div>
</li>
</ul>
<a name="copyValues(org.apache.spark.ml.param.Params,org.apache.spark.ml.param.ParamMap)">
<!--   -->
</a><a name="copyValues(T, org.apache.spark.ml.param.ParamMap)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copyValues</h4>
<pre>&lt;T extends <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>&gt;&nbsp;T&nbsp;copyValues(T&nbsp;to,
                              <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</pre>
<div class="block">Copies param values from this instance to another instance for params shared by them.
 <p>
 This handles default Params and explicitly set Params separately.
 Default Params are copied from and to <code>defaultParamMap</code>, and explicitly set Params are
 copied from and to <code>paramMap</code>.
 Warning: This implicitly assumes that this <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param"><code>Params</code></a> instance and the target instance
          share the same set of default Params.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>to</code> - the target instance, which should work with the same set of default Params as this
           source instance</dd><dd><code>extra</code> - extra params to be copied to the target's <code>paramMap</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the target instance with param values copied</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/param/ParamValidators.html" title="class in org.apache.spark.ml.param"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/param/Params.html" target="_top">Frames</a></li>
<li><a href="Params.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body>
</html>