Skip to content

Commit 8ccd41f

Browse files
wangyumdongjoon-hyun
authored andcommitted
[SPARK-40322][DOCS] Fix all dead links in the docs
### What changes were proposed in this pull request? This PR fixes any dead links in the documentation. ### Why are the changes needed? Correct the document. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? manual test. Closes apache#37981 from wangyum/SPARK-40322. Lead-authored-by: Yuming Wang <[email protected]> Co-authored-by: Yuming Wang <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]>
1 parent 7d13d46 commit 8ccd41f

File tree

9 files changed

+58
-58
lines changed

9 files changed

+58
-58
lines changed

docs/ml-classification-regression.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ More details on parameters can be found in the [Python API documentation](api/py
9292

9393
<div data-lang="r" markdown="1">
9494

95-
More details on parameters can be found in the [R API documentation](api/R/spark.logit.html).
95+
More details on parameters can be found in the [R API documentation](api/R/reference/spark.logit.html).
9696

9797
{% include_example binomial r/ml/logit.R %}
9898
</div>
@@ -195,7 +195,7 @@ training summary for evaluating the model.
195195

196196
<div data-lang="r" markdown="1">
197197

198-
More details on parameters can be found in the [R API documentation](api/R/spark.logit.html).
198+
More details on parameters can be found in the [R API documentation](api/R/reference/spark.logit.html).
199199

200200
{% include_example multinomial r/ml/logit.R %}
201201
</div>
@@ -240,7 +240,7 @@ More details on parameters can be found in the [Python API documentation](api/py
240240

241241
<div data-lang="r" markdown="1">
242242

243-
Refer to the [R API docs](api/R/spark.decisionTree.html) for more details.
243+
Refer to the [R API docs](api/R/reference/spark.decisionTree.html) for more details.
244244

245245
{% include_example classification r/ml/decisionTree.R %}
246246

@@ -282,7 +282,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.classificatio
282282

283283
<div data-lang="r" markdown="1">
284284

285-
Refer to the [R API docs](api/R/spark.randomForest.html) for more details.
285+
Refer to the [R API docs](api/R/reference/spark.randomForest.html) for more details.
286286

287287
{% include_example classification r/ml/randomForest.R %}
288288
</div>
@@ -323,7 +323,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.classificatio
323323

324324
<div data-lang="r" markdown="1">
325325

326-
Refer to the [R API docs](api/R/spark.gbt.html) for more details.
326+
Refer to the [R API docs](api/R/reference/spark.gbt.html) for more details.
327327

328328
{% include_example classification r/ml/gbt.R %}
329329
</div>
@@ -379,7 +379,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.classificatio
379379

380380
<div data-lang="r" markdown="1">
381381

382-
Refer to the [R API docs](api/R/spark.mlp.html) for more details.
382+
Refer to the [R API docs](api/R/reference/spark.mlp.html) for more details.
383383

384384
{% include_example r/ml/mlp.R %}
385385
</div>
@@ -424,7 +424,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.classificatio
424424

425425
<div data-lang="r" markdown="1">
426426

427-
Refer to the [R API docs](api/R/spark.svmLinear.html) for more details.
427+
Refer to the [R API docs](api/R/reference/spark.svmLinear.html) for more details.
428428

429429
{% include_example r/ml/svmLinear.R %}
430430
</div>
@@ -522,7 +522,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.classificatio
522522

523523
<div data-lang="r" markdown="1">
524524

525-
Refer to the [R API docs](api/R/spark.naiveBayes.html) for more details.
525+
Refer to the [R API docs](api/R/reference/spark.naiveBayes.html) for more details.
526526

527527
{% include_example r/ml/naiveBayes.R %}
528528
</div>
@@ -565,7 +565,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.classificatio
565565

566566
<div data-lang="r" markdown="1">
567567

568-
Refer to the [R API docs](api/R/spark.fmClassifier.html) for more details.
568+
Refer to the [R API docs](api/R/reference/spark.fmClassifier.html) for more details.
569569

570570
Note: At the moment SparkR doesn't support feature scaling.
571571

@@ -616,7 +616,7 @@ More details on parameters can be found in the [Python API documentation](api/py
616616

617617
<div data-lang="r" markdown="1">
618618

619-
More details on parameters can be found in the [R API documentation](api/R/spark.lm.html).
619+
More details on parameters can be found in the [R API documentation](api/R/reference/spark.lm.html).
620620

621621
{% include_example r/ml/lm_with_elastic_net.R %}
622622
</div>
@@ -763,7 +763,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.regression.Ge
763763

764764
<div data-lang="r" markdown="1">
765765

766-
Refer to the [R API docs](api/R/spark.glm.html) for more details.
766+
Refer to the [R API docs](api/R/reference/spark.glm.html) for more details.
767767

768768
{% include_example r/ml/glm.R %}
769769
</div>
@@ -805,7 +805,7 @@ More details on parameters can be found in the [Python API documentation](api/py
805805

806806
<div data-lang="r" markdown="1">
807807

808-
Refer to the [R API docs](api/R/spark.decisionTree.html) for more details.
808+
Refer to the [R API docs](api/R/reference/spark.decisionTree.html) for more details.
809809

810810
{% include_example regression r/ml/decisionTree.R %}
811811
</div>
@@ -847,7 +847,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.regression.Ra
847847

848848
<div data-lang="r" markdown="1">
849849

850-
Refer to the [R API docs](api/R/spark.randomForest.html) for more details.
850+
Refer to the [R API docs](api/R/reference/spark.randomForest.html) for more details.
851851

852852
{% include_example regression r/ml/randomForest.R %}
853853
</div>
@@ -888,7 +888,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.regression.GB
888888

889889
<div data-lang="r" markdown="1">
890890

891-
Refer to the [R API docs](api/R/spark.gbt.html) for more details.
891+
Refer to the [R API docs](api/R/reference/spark.gbt.html) for more details.
892892

893893
{% include_example regression r/ml/gbt.R %}
894894
</div>
@@ -982,7 +982,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.regression.AF
982982

983983
<div data-lang="r" markdown="1">
984984

985-
Refer to the [R API docs](api/R/spark.survreg.html) for more details.
985+
Refer to the [R API docs](api/R/reference/spark.survreg.html) for more details.
986986

987987
{% include_example r/ml/survreg.R %}
988988
</div>
@@ -1060,7 +1060,7 @@ Refer to the [`IsotonicRegression` Python docs](api/python/reference/api/pyspark
10601060

10611061
<div data-lang="r" markdown="1">
10621062

1063-
Refer to the [`IsotonicRegression` R API docs](api/R/spark.isoreg.html) for more details on the API.
1063+
Refer to the [`IsotonicRegression` R API docs](api/R/reference/spark.isoreg.html) for more details on the API.
10641064

10651065
{% include_example r/ml/isoreg.R %}
10661066
</div>
@@ -1103,7 +1103,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.regression.FM
11031103

11041104
<div data-lang="r" markdown="1">
11051105

1106-
Refer to the [R API documentation](api/R/spark.fmRegressor.html) for more details.
1106+
Refer to the [R API documentation](api/R/reference/spark.fmRegressor.html) for more details.
11071107

11081108
Note: At the moment SparkR doesn't support feature scaling.
11091109

docs/ml-clustering.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.clustering.KM
104104

105105
<div data-lang="r" markdown="1">
106106

107-
Refer to the [R API docs](api/R/spark.kmeans.html) for more details.
107+
Refer to the [R API docs](api/R/reference/spark.kmeans.html) for more details.
108108

109109
{% include_example r/ml/kmeans.R %}
110110
</div>
@@ -144,7 +144,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.clustering.LD
144144

145145
<div data-lang="r" markdown="1">
146146

147-
Refer to the [R API docs](api/R/spark.lda.html) for more details.
147+
Refer to the [R API docs](api/R/reference/spark.lda.html) for more details.
148148

149149
{% include_example r/ml/lda.R %}
150150
</div>
@@ -185,7 +185,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.clustering.Bi
185185

186186
<div data-lang="r" markdown="1">
187187

188-
Refer to the [R API docs](api/R/spark.bisectingKmeans.html) for more details.
188+
Refer to the [R API docs](api/R/reference/spark.bisectingKmeans.html) for more details.
189189

190190
{% include_example r/ml/bisectingKmeans.R %}
191191
</div>
@@ -274,7 +274,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.clustering.Ga
274274

275275
<div data-lang="r" markdown="1">
276276

277-
Refer to the [R API docs](api/R/spark.gaussianMixture.html) for more details.
277+
Refer to the [R API docs](api/R/reference/spark.gaussianMixture.html) for more details.
278278

279279
{% include_example r/ml/gaussianMixture.R %}
280280
</div>
@@ -321,7 +321,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.clustering.Po
321321

322322
<div data-lang="r" markdown="1">
323323

324-
Refer to the [R API docs](api/R/spark.powerIterationClustering.html) for more details.
324+
Refer to the [R API docs](api/R/reference/spark.powerIterationClustering.html) for more details.
325325

326326
{% include_example r/ml/powerIterationClustering.R %}
327327
</div>

docs/ml-collaborative-filtering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ als = ALS(maxIter=5, regParam=0.01, implicitPrefs=True,
195195

196196
<div data-lang="r" markdown="1">
197197

198-
Refer to the [R API docs](api/R/spark.als.html) for more details.
198+
Refer to the [R API docs](api/R/reference/spark.als.html) for more details.
199199

200200
{% include_example r/ml/als.R %}
201201
</div>

docs/ml-frequent-pattern-mining.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.fpm.FPGrowth.
102102

103103
<div data-lang="r" markdown="1">
104104

105-
Refer to the [R API docs](api/R/spark.fpGrowth.html) for more details.
105+
Refer to the [R API docs](api/R/reference/spark.fpGrowth.html) for more details.
106106

107107
{% include_example r/ml/fpm.R %}
108108
</div>
@@ -155,7 +155,7 @@ Refer to the [Python API docs](api/python/reference/api/pyspark.ml.fpm.PrefixSpa
155155

156156
<div data-lang="r" markdown="1">
157157

158-
Refer to the [R API docs](api/R/spark.prefixSpan.html) for more details.
158+
Refer to the [R API docs](api/R/reference/spark.prefixSpan.html) for more details.
159159

160160
{% include_example r/ml/prefixSpan.R %}
161161
</div>

docs/rdd-programming-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -951,7 +951,7 @@ RDD API doc
951951
([Scala](api/scala/org/apache/spark/rdd/RDD.html),
952952
[Java](api/java/index.html?org/apache/spark/api/java/JavaRDD.html),
953953
[Python](api/python/reference/api/pyspark.RDD.html#pyspark.RDD),
954-
[R](api/R/index.html))
954+
[R](api/R/reference/index.html))
955955
and pair RDD functions doc
956956
([Scala](api/scala/org/apache/spark/rdd/PairRDDFunctions.html),
957957
[Java](api/java/index.html?org/apache/spark/api/java/JavaPairRDD.html))
@@ -1065,7 +1065,7 @@ RDD API doc
10651065
([Scala](api/scala/org/apache/spark/rdd/RDD.html),
10661066
[Java](api/java/index.html?org/apache/spark/api/java/JavaRDD.html),
10671067
[Python](api/python/reference/api/pyspark.RDD.html#pyspark.RDD),
1068-
[R](api/R/index.html))
1068+
[R](api/R/reference/index.html))
10691069

10701070
and pair RDD functions doc
10711071
([Scala](api/scala/org/apache/spark/rdd/PairRDDFunctions.html),

docs/sparkr.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ people <- read.json(c("./examples/src/main/resources/people.json", "./examples/s
175175
{% endhighlight %}
176176
</div>
177177

178-
The data sources API natively supports CSV formatted input files. For more information please refer to SparkR [read.df](api/R/read.df.html) API documentation.
178+
The data sources API natively supports CSV formatted input files. For more information please refer to SparkR [read.df](api/R/reference/read.df.html) API documentation.
179179

180180
<div data-lang="r" markdown="1">
181181
{% highlight r %}
@@ -536,49 +536,49 @@ SparkR supports the following machine learning algorithms currently:
536536

537537
#### Classification
538538

539-
* [`spark.logit`](api/R/spark.logit.html): [`Logistic Regression`](ml-classification-regression.html#logistic-regression)
540-
* [`spark.mlp`](api/R/spark.mlp.html): [`Multilayer Perceptron (MLP)`](ml-classification-regression.html#multilayer-perceptron-classifier)
541-
* [`spark.naiveBayes`](api/R/spark.naiveBayes.html): [`Naive Bayes`](ml-classification-regression.html#naive-bayes)
542-
* [`spark.svmLinear`](api/R/spark.svmLinear.html): [`Linear Support Vector Machine`](ml-classification-regression.html#linear-support-vector-machine)
543-
* [`spark.fmClassifier`](api/R/fmClassifier.html): [`Factorization Machines classifier`](ml-classification-regression.html#factorization-machines-classifier)
539+
* [`spark.logit`](api/R/reference/spark.logit.html): [`Logistic Regression`](ml-classification-regression.html#logistic-regression)
540+
* [`spark.mlp`](api/R/reference/spark.mlp.html): [`Multilayer Perceptron (MLP)`](ml-classification-regression.html#multilayer-perceptron-classifier)
541+
* [`spark.naiveBayes`](api/R/reference/spark.naiveBayes.html): [`Naive Bayes`](ml-classification-regression.html#naive-bayes)
542+
* [`spark.svmLinear`](api/R/reference/spark.svmLinear.html): [`Linear Support Vector Machine`](ml-classification-regression.html#linear-support-vector-machine)
543+
* [`spark.fmClassifier`](api/R/reference/fmClassifier.html): [`Factorization Machines classifier`](ml-classification-regression.html#factorization-machines-classifier)
544544

545545
#### Regression
546546

547-
* [`spark.survreg`](api/R/spark.survreg.html): [`Accelerated Failure Time (AFT) Survival Model`](ml-classification-regression.html#survival-regression)
548-
* [`spark.glm`](api/R/spark.glm.html) or [`glm`](api/R/glm.html): [`Generalized Linear Model (GLM)`](ml-classification-regression.html#generalized-linear-regression)
549-
* [`spark.isoreg`](api/R/spark.isoreg.html): [`Isotonic Regression`](ml-classification-regression.html#isotonic-regression)
550-
* [`spark.lm`](api/R/spark.lm.html): [`Linear Regression`](ml-classification-regression.html#linear-regression)
551-
* [`spark.fmRegressor`](api/R/spark.fmRegressor.html): [`Factorization Machines regressor`](ml-classification-regression.html#factorization-machines-regressor)
547+
* [`spark.survreg`](api/R/reference/spark.survreg.html): [`Accelerated Failure Time (AFT) Survival Model`](ml-classification-regression.html#survival-regression)
548+
* [`spark.glm`](api/R/reference/spark.glm.html) or [`glm`](api/R/reference/glm.html): [`Generalized Linear Model (GLM)`](ml-classification-regression.html#generalized-linear-regression)
549+
* [`spark.isoreg`](api/R/reference/spark.isoreg.html): [`Isotonic Regression`](ml-classification-regression.html#isotonic-regression)
550+
* [`spark.lm`](api/R/reference/spark.lm.html): [`Linear Regression`](ml-classification-regression.html#linear-regression)
551+
* [`spark.fmRegressor`](api/R/reference/spark.fmRegressor.html): [`Factorization Machines regressor`](ml-classification-regression.html#factorization-machines-regressor)
552552

553553
#### Tree
554554

555-
* [`spark.decisionTree`](api/R/spark.decisionTree.html): `Decision Tree for` [`Regression`](ml-classification-regression.html#decision-tree-regression) `and` [`Classification`](ml-classification-regression.html#decision-tree-classifier)
556-
* [`spark.gbt`](api/R/spark.gbt.html): `Gradient Boosted Trees for` [`Regression`](ml-classification-regression.html#gradient-boosted-tree-regression) `and` [`Classification`](ml-classification-regression.html#gradient-boosted-tree-classifier)
557-
* [`spark.randomForest`](api/R/spark.randomForest.html): `Random Forest for` [`Regression`](ml-classification-regression.html#random-forest-regression) `and` [`Classification`](ml-classification-regression.html#random-forest-classifier)
555+
* [`spark.decisionTree`](api/R/reference/spark.decisionTree.html): `Decision Tree for` [`Regression`](ml-classification-regression.html#decision-tree-regression) `and` [`Classification`](ml-classification-regression.html#decision-tree-classifier)
556+
* [`spark.gbt`](api/R/reference/spark.gbt.html): `Gradient Boosted Trees for` [`Regression`](ml-classification-regression.html#gradient-boosted-tree-regression) `and` [`Classification`](ml-classification-regression.html#gradient-boosted-tree-classifier)
557+
* [`spark.randomForest`](api/R/reference/spark.randomForest.html): `Random Forest for` [`Regression`](ml-classification-regression.html#random-forest-regression) `and` [`Classification`](ml-classification-regression.html#random-forest-classifier)
558558

559559
#### Clustering
560560

561-
* [`spark.bisectingKmeans`](api/R/spark.bisectingKmeans.html): [`Bisecting k-means`](ml-clustering.html#bisecting-k-means)
562-
* [`spark.gaussianMixture`](api/R/spark.gaussianMixture.html): [`Gaussian Mixture Model (GMM)`](ml-clustering.html#gaussian-mixture-model-gmm)
563-
* [`spark.kmeans`](api/R/spark.kmeans.html): [`K-Means`](ml-clustering.html#k-means)
564-
* [`spark.lda`](api/R/spark.lda.html): [`Latent Dirichlet Allocation (LDA)`](ml-clustering.html#latent-dirichlet-allocation-lda)
565-
* [`spark.powerIterationClustering (PIC)`](api/R/spark.powerIterationClustering.html): [`Power Iteration Clustering (PIC)`](ml-clustering.html#power-iteration-clustering-pic)
561+
* [`spark.bisectingKmeans`](api/R/reference/spark.bisectingKmeans.html): [`Bisecting k-means`](ml-clustering.html#bisecting-k-means)
562+
* [`spark.gaussianMixture`](api/R/reference/spark.gaussianMixture.html): [`Gaussian Mixture Model (GMM)`](ml-clustering.html#gaussian-mixture-model-gmm)
563+
* [`spark.kmeans`](api/R/reference/spark.kmeans.html): [`K-Means`](ml-clustering.html#k-means)
564+
* [`spark.lda`](api/R/reference/spark.lda.html): [`Latent Dirichlet Allocation (LDA)`](ml-clustering.html#latent-dirichlet-allocation-lda)
565+
* [`spark.powerIterationClustering (PIC)`](api/R/reference/spark.powerIterationClustering.html): [`Power Iteration Clustering (PIC)`](ml-clustering.html#power-iteration-clustering-pic)
566566

567567
#### Collaborative Filtering
568568

569-
* [`spark.als`](api/R/spark.als.html): [`Alternating Least Squares (ALS)`](ml-collaborative-filtering.html#collaborative-filtering)
569+
* [`spark.als`](api/R/reference/spark.als.html): [`Alternating Least Squares (ALS)`](ml-collaborative-filtering.html#collaborative-filtering)
570570

571571
#### Frequent Pattern Mining
572572

573-
* [`spark.fpGrowth`](api/R/spark.fpGrowth.html) : [`FP-growth`](ml-frequent-pattern-mining.html#fp-growth)
574-
* [`spark.prefixSpan`](api/R/spark.prefixSpan.html) : [`PrefixSpan`](ml-frequent-pattern-mining.html#prefixSpan)
573+
* [`spark.fpGrowth`](api/R/reference/spark.fpGrowth.html) : [`FP-growth`](ml-frequent-pattern-mining.html#fp-growth)
574+
* [`spark.prefixSpan`](api/R/reference/spark.prefixSpan.html) : [`PrefixSpan`](ml-frequent-pattern-mining.html#prefixSpan)
575575

576576
#### Statistics
577577

578-
* [`spark.kstest`](api/R/spark.kstest.html): `Kolmogorov-Smirnov Test`
578+
* [`spark.kstest`](api/R/reference/spark.kstest.html): `Kolmogorov-Smirnov Test`
579579

580580
Under the hood, SparkR uses MLlib to train the model. Please refer to the corresponding section of MLlib user guide for example code.
581-
Users can call `summary` to print a summary of the fitted model, [predict](api/R/predict.html) to make predictions on new data, and [write.ml](api/R/write.ml.html)/[read.ml](api/R/read.ml.html) to save/load fitted models.
581+
Users can call `summary` to print a summary of the fitted model, [predict](api/R/reference/predict.html) to make predictions on new data, and [write.ml](api/R/reference/write.ml.html)/[read.ml](api/R/reference/read.ml.html) to save/load fitted models.
582582
SparkR supports a subset of the available R formula operators for model fitting, including ‘~’, ‘.’, ‘:’, ‘+’, and ‘-‘.
583583

584584

0 commit comments

Comments
 (0)