Ignite-7094: Javadoc warnings in ml module this closes #3131
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/104a7c8f Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/104a7c8f Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/104a7c8f Branch: refs/heads/ignite-zk Commit: 104a7c8fa36bbfb867476f3e26cd37c89f242281 Parents: a29fe35 Author: YuriBabak <[email protected]> Authored: Sat Dec 2 17:35:32 2017 +0300 Committer: YuriBabak <[email protected]> Committed: Sat Dec 2 17:35:32 2017 +0300 ---------------------------------------------------------------------- .../impls/storage/vector/SparseDistributedVectorStorage.java | 3 ++- .../org/apache/ignite/ml/trees/ContinuousSplitCalculator.java | 3 ++- .../columnbased/CacheColumnDecisionTreeTrainerInput.java | 7 +++---- .../trainers/columnbased/ColumnDecisionTreeTrainerInput.java | 2 +- .../columnbased/MatrixColumnDecisionTreeTrainerInput.java | 5 +++-- .../columnbased/vectors/CategoricalFeatureProcessor.java | 3 ++- .../trees/trainers/columnbased/vectors/FeatureProcessor.java | 5 +++-- 7 files changed, 16 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/104a7c8f/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseDistributedVectorStorage.java ---------------------------------------------------------------------- diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseDistributedVectorStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseDistributedVectorStorage.java index af1c2cd..0496d05 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseDistributedVectorStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseDistributedVectorStorage.java @@ -36,9 +36,10 @@ import org.apache.ignite.ml.math.distributed.CacheUtils; import org.apache.ignite.ml.math.distributed.DistributedStorage; import org.apache.ignite.ml.math.distributed.keys.RowColMatrixKey; import org.apache.ignite.ml.math.distributed.keys.impl.SparseMatrixKey; +import org.apache.ignite.ml.math.impls.vector.SparseDistributedVector; /** - * {@link VectorStorage} implementation for {@link /*SparseDistributedVector}. + * {@link VectorStorage} implementation for {@link SparseDistributedVector}. */ public class SparseDistributedVectorStorage extends CacheUtils implements VectorStorage, StorageConstants, DistributedStorage<RowColMatrixKey> { /** Cache name used for all instances of {@link SparseDistributedVectorStorage}. */ http://git-wip-us.apache.org/repos/asf/ignite/blob/104a7c8f/modules/ml/src/main/java/org/apache/ignite/ml/trees/ContinuousSplitCalculator.java ---------------------------------------------------------------------- diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/trees/ContinuousSplitCalculator.java b/modules/ml/src/main/java/org/apache/ignite/ml/trees/ContinuousSplitCalculator.java index f9b81d0..3a0e9da 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/trees/ContinuousSplitCalculator.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/trees/ContinuousSplitCalculator.java @@ -19,6 +19,7 @@ package org.apache.ignite.ml.trees; import java.util.stream.DoubleStream; import org.apache.ignite.ml.trees.trainers.columnbased.vectors.SplitInfo; +import org.apache.ignite.ml.trees.trainers.columnbased.vectors.ContinuousFeatureProcessor; /** * This class is used for calculation of best split by continuous feature. @@ -31,7 +32,7 @@ public interface ContinuousSplitCalculator<C extends ContinuousRegionInfo> { * * @param s Stream of labels in this region. * @param l Index of sample projection on this feature in array sorted by this projection value and intervals - * bitsets. ({@see org.apache.ignite.ml.trees.trainers.columnbased.vectors.ContinuousFeatureProcessor}). + * bitsets. ({@link ContinuousFeatureProcessor}). * @return Region info. */ C calculateRegionInfo(DoubleStream s, int l); http://git-wip-us.apache.org/repos/asf/ignite/blob/104a7c8f/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/CacheColumnDecisionTreeTrainerInput.java ---------------------------------------------------------------------- diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/CacheColumnDecisionTreeTrainerInput.java b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/CacheColumnDecisionTreeTrainerInput.java index 9518caf..40927b7 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/CacheColumnDecisionTreeTrainerInput.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/CacheColumnDecisionTreeTrainerInput.java @@ -31,7 +31,7 @@ import org.apache.ignite.ml.math.functions.IgniteFunction; import org.apache.ignite.ml.math.functions.IgniteSupplier; /** - * Adapter of a given cache to {@see CacheColumnDecisionTreeTrainerInput} + * Adapter of a given cache to {@link CacheColumnDecisionTreeTrainerInput} * * @param <K> Class of keys of the cache. * @param <V> Class of values of the cache. @@ -66,11 +66,10 @@ public abstract class CacheColumnDecisionTreeTrainerInput<K, V> implements Colum private final IgniteFunction<V, DoubleStream> labelsMapper; /** - * Constructs input for {@see org.apache.ignite.ml.trees.trainers.columnbased.ColumnDecisionTreeTrainer}. + * Constructs input for {@link ColumnDecisionTreeTrainer}. * * @param c Cache. - * @param valuesMapper Function for mapping cache entry to stream used by {@link - * org.apache.ignite.ml.trees.trainers.columnbased.ColumnDecisionTreeTrainer}. + * @param valuesMapper Function for mapping cache entry to stream used by {@link ColumnDecisionTreeTrainer}. * @param labelsMapper Function used for mapping cache value to labels array. * @param keyMapper Function used for mapping feature index to the cache key. * @param catFeaturesInfo Information about which features are categorical in form of feature index -> number of http://git-wip-us.apache.org/repos/asf/ignite/blob/104a7c8f/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/ColumnDecisionTreeTrainerInput.java ---------------------------------------------------------------------- diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/ColumnDecisionTreeTrainerInput.java b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/ColumnDecisionTreeTrainerInput.java index 94331f7..bf8790b 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/ColumnDecisionTreeTrainerInput.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/ColumnDecisionTreeTrainerInput.java @@ -23,7 +23,7 @@ import org.apache.ignite.Ignite; import org.apache.ignite.lang.IgniteBiTuple; /** - * Input for {@see ColumnDecisionTreeTrainer}. + * Input for {@link ColumnDecisionTreeTrainer}. */ public interface ColumnDecisionTreeTrainerInput { /** http://git-wip-us.apache.org/repos/asf/ignite/blob/104a7c8f/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/MatrixColumnDecisionTreeTrainerInput.java ---------------------------------------------------------------------- diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/MatrixColumnDecisionTreeTrainerInput.java b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/MatrixColumnDecisionTreeTrainerInput.java index 9a11902..3da6bad 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/MatrixColumnDecisionTreeTrainerInput.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/MatrixColumnDecisionTreeTrainerInput.java @@ -30,16 +30,17 @@ import org.apache.ignite.ml.math.distributed.keys.impl.SparseMatrixKey; import org.apache.ignite.ml.math.functions.IgniteFunction; import org.apache.ignite.ml.math.impls.matrix.SparseDistributedMatrix; import org.apache.ignite.ml.math.impls.storage.matrix.SparseDistributedMatrixStorage; +import org.apache.ignite.ml.math.StorageConstants; import org.jetbrains.annotations.NotNull; /** * Adapter of SparseDistributedMatrix to ColumnDecisionTreeTrainerInput. - * Sparse SparseDistributedMatrix should be in {@see org.apache.ignite.ml.math.StorageConstants#COLUMN_STORAGE_MODE} and + * Sparse SparseDistributedMatrix should be in {@link StorageConstants#COLUMN_STORAGE_MODE} and * should contain samples in rows last position in row being label of this sample. */ public class MatrixColumnDecisionTreeTrainerInput extends CacheColumnDecisionTreeTrainerInput<RowColMatrixKey, Map<Integer, Double>> { /** - * @param m Sparse SparseDistributedMatrix should be in {@see org.apache.ignite.ml.math.StorageConstants#COLUMN_STORAGE_MODE} + * @param m Sparse SparseDistributedMatrix should be in {@link StorageConstants#COLUMN_STORAGE_MODE} * containing samples in rows last position in row being label of this sample. * @param catFeaturesInfo Information about which features are categorical in form of feature index -> number of * categories. http://git-wip-us.apache.org/repos/asf/ignite/blob/104a7c8f/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/CategoricalFeatureProcessor.java ---------------------------------------------------------------------- diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/CategoricalFeatureProcessor.java b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/CategoricalFeatureProcessor.java index 9469768..3232ac2 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/CategoricalFeatureProcessor.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/CategoricalFeatureProcessor.java @@ -34,12 +34,13 @@ import org.apache.ignite.ml.math.functions.IgniteFunction; import org.apache.ignite.ml.trees.CategoricalRegionInfo; import org.apache.ignite.ml.trees.CategoricalSplitInfo; import org.apache.ignite.ml.trees.RegionInfo; +import org.apache.ignite.ml.trees.trainers.columnbased.ColumnDecisionTreeTrainer; import org.apache.ignite.ml.trees.trainers.columnbased.RegionProjection; import static org.apache.ignite.ml.trees.trainers.columnbased.vectors.FeatureVectorProcessorUtils.splitByBitSet; /** - * Categorical feature vector processor implementation used by {@see ColumnDecisionTreeTrainer}. + * Categorical feature vector processor implementation used by {@link ColumnDecisionTreeTrainer}. */ public class CategoricalFeatureProcessor implements FeatureProcessor<CategoricalRegionInfo, CategoricalSplitInfo<CategoricalRegionInfo>> { http://git-wip-us.apache.org/repos/asf/ignite/blob/104a7c8f/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/FeatureProcessor.java ---------------------------------------------------------------------- diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/FeatureProcessor.java b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/FeatureProcessor.java index cb8f5c2..56508e5 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/FeatureProcessor.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/trees/trainers/columnbased/vectors/FeatureProcessor.java @@ -20,10 +20,11 @@ package org.apache.ignite.ml.trees.trainers.columnbased.vectors; import com.zaxxer.sparsebits.SparseBitSet; import org.apache.ignite.lang.IgniteBiTuple; import org.apache.ignite.ml.trees.RegionInfo; +import org.apache.ignite.ml.trees.trainers.columnbased.ColumnDecisionTreeTrainer; import org.apache.ignite.ml.trees.trainers.columnbased.RegionProjection; /** - * Base interface for feature processors used in {@see org.apache.ignite.ml.trees.trainers.columnbased.ColumnDecisionTreeTrainer} + * Base interface for feature processors used in {@link ColumnDecisionTreeTrainer} * * @param <D> Class representing data of regions resulted from split. * @param <S> Class representing data of split. @@ -68,7 +69,7 @@ public interface FeatureProcessor<D extends RegionInfo, S extends SplitInfo<D>> /** * Splits given region using bitset which maps data point to left or right subregion. This method is used iff the * optimal split is received on feature of different type, therefore information about regions is limited to the - * {@see RegionInfo} class which is base for all classes used to represent region data. + * {@link RegionInfo} class which is base for all classes used to represent region data. * * @param bs Bitset which maps data point to left or right subregion. * @param leftData Data of the left subregion.
