Skip to content

Commit

Permalink
Merge pull request #28 from robertboloc/feature-documentation-fixes
Browse files Browse the repository at this point in the history
Fix a few broken documentation links
  • Loading branch information
akondas authored Jan 6, 2017
2 parents a78ebc1 + aace5ff commit cb5a995
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Classifier implementing the k-nearest neighbors algorithm.
## Constructor Parameters

* $k - number of nearest neighbors to scan (default: 3)
* $distanceMetric - Distance object, default Euclidean (see [distance documentation](math/distance/))
* $distanceMetric - Distance object, default Euclidean (see [distance documentation](../../math/distance.md))

```
$classifier = new KNearestNeighbors($k=4);
Expand Down
2 changes: 1 addition & 1 deletion docs/machine-learning/clustering/dbscan.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ It is a density-based clustering algorithm: given a set of points in some space,

* $epsilon - epsilon, maximum distance between two samples for them to be considered as in the same neighborhood
* $minSamples - number of samples in a neighborhood for a point to be considered as a core point (this includes the point itself)
* $distanceMetric - Distance object, default Euclidean (see [distance documentation](math/distance/))
* $distanceMetric - Distance object, default Euclidean (see [distance documentation](../../math/distance.md))

```
$dbscan = new DBSCAN($epsilon = 2, $minSamples = 3);
Expand Down
2 changes: 1 addition & 1 deletion docs/machine-learning/datasets/csv-dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Helper class that loads data from CSV file. It extends the `ArrayDataset`.
$dataset = new CsvDataset('dataset.csv', 2, true);
```

See [ArrayDataset](machine-learning/datasets/array-dataset/) for more information.
See [ArrayDataset](array-dataset.md) for more information.
2 changes: 1 addition & 1 deletion docs/machine-learning/datasets/files-dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use Phpml\Dataset\FilesDataset;
$dataset = new FilesDataset('path/to/data');
```

See [ArrayDataset](machine-learning/datasets/array-dataset/) for more information.
See [ArrayDataset](array-dataset.md) for more information.

### Example

Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ site_name: PHP-ML - Machine Learning library for PHP
pages:
- Home: index.md
- Machine Learning:
- Association rule learning:
- Apriori: machine-learning/association/apriori.md
- Classification:
- SVC: machine-learning/classification/svc.md
- KNearestNeighbors: machine-learning/classification/k-nearest-neighbors.md
Expand Down Expand Up @@ -41,5 +43,6 @@ pages:
- Math:
- Distance: math/distance.md
- Matrix: math/matrix.md
- Set: math/set.md
- Statistic: math/statistic.md
theme: readthedocs

0 comments on commit cb5a995

Please sign in to comment.