Author: edwardyoon
Date: Fri May 30 07:12:15 2014
New Revision: 1598471
URL: http://svn.apache.org/r1598471
Log:
HAMA-823: Remove javadoc warnings (Victor Lee via edwardyoon)
Modified:
hama/trunk/CHANGES.txt
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleFunction.java
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleMatrix.java
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleVector.java
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/FunctionFactory.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/BSPMaster.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/CombineFileInputFormat.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/FileInputFormat.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/FileOutputFormat.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/RecordWriter.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskCompletionEvent.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskInProgress.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/HamaMessageManagerImpl.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/MessageManagerFactory.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/BSPMessageCompressorFactory.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/Bzip2Compressor.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/SnappyCompressor.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/ByteBufferOutputStream.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/SpillingDataOutputBuffer.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncClient.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncServer.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZKSyncClient.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZooKeeperSyncClientImpl.java
hama/trunk/core/src/main/java/org/apache/hama/bsp/taskallocation/BestEffortDataLocalTaskAllocator.java
hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java
hama/trunk/graph/src/main/java/org/apache/hama/graph/AggregationRunner.java
hama/trunk/graph/src/main/java/org/apache/hama/graph/Vertex.java
hama/trunk/graph/src/main/java/org/apache/hama/graph/VertexInterface.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AbstractLayeredNeuralNetwork.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AutoEncoder.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/NeuralNetwork.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/SmallLayeredNeuralNetwork.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/kmeans/KMeansBSP.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMLPMessage.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMultiLayerPerceptron.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/recommendation/Recommender.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LinearRegression.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LogisticRegression.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/semiclustering/SemiClusteringVertex.java
hama/trunk/ml/src/main/java/org/apache/hama/ml/util/FeatureTransformer.java
Modified: hama/trunk/CHANGES.txt
URL:
http://svn.apache.org/viewvc/hama/trunk/CHANGES.txt?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/CHANGES.txt (original)
+++ hama/trunk/CHANGES.txt Fri May 30 07:12:15 2014
@@ -15,7 +15,8 @@ Release 0.7.0 (unreleased changes)
HAMA-885: Semi-Clustering is not producing expected output (Renil J via
edwardyoon)
IMPROVEMENTS
-
+
+ HAMA-823: Remove javadoc warnings (Victor Lee via edwardyoon)
HAMA-886: Refactoring core.bundle package (edwardyoon)
HAMA-899: Add getAdjacentPeerNames() that returns the names of locally
adjacent peers (edwardyoon)
HAMA-847: Vertex should provide Counters (edwardyoon)
Modified:
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleFunction.java
URL:
http://svn.apache.org/viewvc/hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleFunction.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleFunction.java
(original)
+++
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleFunction.java
Fri May 30 07:12:15 2014
@@ -27,7 +27,7 @@ public abstract class DoubleFunction ext
/**
* Apply the function to element.
*
- * @param elem The element that the function apply to.
+ * @param value The element that the function apply to.
* @return The result after applying the function.
*/
public abstract double apply(double value);
@@ -35,8 +35,8 @@ public abstract class DoubleFunction ext
/**
* Apply the gradient of the function.
*
- * @param elem
- * @return
+ * @param value
+ * @return The result after applying the function.
*/
public abstract double applyDerivative(double value);
Modified:
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleMatrix.java
URL:
http://svn.apache.org/viewvc/hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleMatrix.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleMatrix.java
(original)
+++
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleMatrix.java
Fri May 30 07:12:15 2014
@@ -82,7 +82,7 @@ public interface DoubleMatrix {
* Multiplies this matrix with the given other matrix.
*
* @param other the other matrix.
- * @return
+ * @return The matrix itself, supply for chain operation.
*/
public DoubleMatrix multiplyUnsafe(DoubleMatrix other);
@@ -90,7 +90,7 @@ public interface DoubleMatrix {
* Validates the input and multiplies this matrix with the given other
matrix.
*
* @param other the other matrix.
- * @return
+ * @return The matrix itself, supply for chain operation.
*/
public DoubleMatrix multiply(DoubleMatrix other);
@@ -104,7 +104,7 @@ public interface DoubleMatrix {
* matrix.
*
* @param other the other matrix
- * @return
+ * @return The matrix itself, supply for chain operation.
*/
public DoubleMatrix multiplyElementWise(DoubleMatrix other);
@@ -119,7 +119,7 @@ public interface DoubleMatrix {
* the sum of the rows.
*
* @param v the vector
- * @return
+ * @return a new vector with the result of the operation.
*/
public DoubleVector multiplyVector(DoubleVector v);
@@ -149,7 +149,7 @@ public interface DoubleMatrix {
* Validates the input and subtracts this matrix by the given other matrix.
*
* @param other
- * @return
+ * @return The matrix itself, supply for chain operation.
*/
public DoubleMatrix subtract(DoubleMatrix other);
@@ -164,7 +164,7 @@ public interface DoubleMatrix {
* the given vector.
*
* @param vec
- * @return
+ * @return The matrix itself, supply for chain operation.
*/
public DoubleMatrix subtract(DoubleVector vec);
@@ -179,7 +179,7 @@ public interface DoubleMatrix {
* the given vector.
*
* @param vec
- * @return
+ * @return The matrix itself, supply for chain operation.
*/
public DoubleMatrix divide(DoubleVector vec);
@@ -193,7 +193,7 @@ public interface DoubleMatrix {
* division).
*
* @param other
- * @return
+ * @return The matrix itself, supply for chain operation.
*/
public DoubleMatrix divide(DoubleMatrix other);
Modified:
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleVector.java
URL:
http://svn.apache.org/viewvc/hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleVector.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleVector.java
(original)
+++
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/DoubleVector.java
Fri May 30 07:12:15 2014
@@ -166,7 +166,7 @@ public interface DoubleVector {
* vector.
*
* @param matrix
- * @return
+ * @return a new vector with the result of the operation.
*/
public DoubleVector multiply(DoubleMatrix matrix);
@@ -174,7 +174,7 @@ public interface DoubleVector {
* Multiplies the given {@link DoubleMatrix} with this vector.
*
* @param matrix
- * @return
+ * @return a new vector with the result of the operation.
*/
public DoubleVector multiplyUnsafe(DoubleMatrix matrix);
Modified:
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/FunctionFactory.java
URL:
http://svn.apache.org/viewvc/hama/trunk/commons/src/main/java/org/apache/hama/commons/math/FunctionFactory.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/FunctionFactory.java
(original)
+++
hama/trunk/commons/src/main/java/org/apache/hama/commons/math/FunctionFactory.java
Fri May 30 07:12:15 2014
@@ -27,7 +27,7 @@ public class FunctionFactory {
* Create a double function with specified name.
*
* @param functionName
- * @return
+ * @return an appropriate double function.
*/
public static DoubleFunction createDoubleFunction(String functionName) {
if (functionName.equalsIgnoreCase(Sigmoid.class.getSimpleName())) {
@@ -47,7 +47,7 @@ public class FunctionFactory {
* Create a double double function with specified name.
*
* @param functionName
- * @return
+ * @return an appropriate double double function.
*/
public static DoubleDoubleFunction createDoubleDoubleFunction(
String functionName) {
Modified: hama/trunk/core/src/main/java/org/apache/hama/bsp/BSPMaster.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/BSPMaster.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/BSPMaster.java (original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/BSPMaster.java Fri May 30
07:12:15 2014
@@ -480,7 +480,7 @@ public class BSPMaster implements JobSub
*
* @param conf The Hama configuration
* @param identifier Identifier for the job.
- * @return
+ * @return an instance of BSPMaster
* @throws IOException
* @throws InterruptedException
*/
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/CombineFileInputFormat.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/CombineFileInputFormat.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/CombineFileInputFormat.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/CombineFileInputFormat.java
Fri May 30 07:12:15 2014
@@ -77,7 +77,7 @@ public abstract class CombineFileInputFo
*
* @param split
* @param context
- * @return
+ * @return a {@link RecordReader} to read the input for processing.
* @throws IOException
*/
public abstract RecordReader<K, V> createRecordReader(InputSplit split,
Modified: hama/trunk/core/src/main/java/org/apache/hama/bsp/FileInputFormat.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/FileInputFormat.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/FileInputFormat.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/FileInputFormat.java Fri
May 30 07:12:15 2014
@@ -375,7 +375,7 @@ public abstract class FileInputFormat<K,
* Add a {@link Path} to the list of inputs for the BSP job.
*
* @param conf The configuration of the job
- * @param path {@link Path} to be added to the list of inputs for the BSP
job.
+ * @param p {@link Path} to be addaiaied to the list of inputs for the BSP
job.
*/
public static void addInputPath(BSPJob conf, Path p) {
Path path = new Path(conf.getWorkingDirectory(), p);
@@ -465,7 +465,7 @@ public abstract class FileInputFormat<K,
*
* @param blkLocations The list of block locations
* @param offset
- * @param splitSize
+ * @param pSplitSize
* @return array of hosts that contribute most to this split
* @throws IOException
*/
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/FileOutputFormat.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/FileOutputFormat.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/FileOutputFormat.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/FileOutputFormat.java Fri
May 30 07:12:15 2014
@@ -146,7 +146,7 @@ public abstract class FileOutputFormat<K
* Get the {@link Path} to the output directory for the map-reduce job.
*
* @return the {@link Path} to the output directory for the map-reduce job.
- * @see FileOutputFormat#getWorkOutputPath(JobConf)
+ * @see FileOutputFormat#getWorkOutputPath(BSPJob)
*/
public static Path getOutputPath(BSPJob conf) {
String name = conf.get("bsp.output.dir");
Modified: hama/trunk/core/src/main/java/org/apache/hama/bsp/RecordWriter.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/RecordWriter.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/RecordWriter.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/RecordWriter.java Fri May
30 07:12:15 2014
@@ -32,7 +32,6 @@ public interface RecordWriter<K, V> {
/**
* Close this <code>RecordWriter</code> to future operations.
*
- * @param reporter facility to report progress.
* @throws IOException
*/
void close() throws IOException;
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskCompletionEvent.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskCompletionEvent.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskCompletionEvent.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskCompletionEvent.java
Fri May 30 07:12:15 2014
@@ -53,7 +53,7 @@ public class TaskCompletionEvent impleme
* incrementally, starting from 0.
* @param taskId task id
* @param status task's status
- * @param taskTrackerHttp task tracker's host:port for http.
+ * @param groomServerInfo task tracker's host:port for http.
*/
public TaskCompletionEvent(int eventId, TaskAttemptID taskId,
int idWithinJob, Status status, String groomServerInfo) {
Modified: hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskInProgress.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskInProgress.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskInProgress.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/TaskInProgress.java Fri
May 30 07:12:15 2014
@@ -137,7 +137,7 @@ public class TaskInProgress {
* @param grooms
* @param tasksInGroomMap
* @param possibleLocations
- * @return
+ * @return a hostname of Groom Server.
*/
private String getGroomToSchedule(TaskAttemptID taskid,
Map<String, GroomServerStatus> grooms,
@@ -162,7 +162,7 @@ public class TaskInProgress {
*
* @param grooms
* @param tasksInGroomMap
- * @return
+ * @return a hostname of Groom Server.
*/
private String getAnyGroomToSchedule(Map<String, GroomServerStatus> grooms,
Map<GroomServerStatus, Integer> tasksInGroomMap) {
@@ -183,8 +183,7 @@ public class TaskInProgress {
/**
*
* @param groomStatus
- * @param grooms
- * @return
+ * @return a new task with job.
*/
public Task constructTask(GroomServerStatus groomStatus) {
if (groomStatus == null) {
@@ -261,7 +260,7 @@ public class TaskInProgress {
/**
*
- * @return
+ * @return true if the task can start.
*/
public boolean canStartTask() {
return (nextTaskId < (MAX_TASK_EXECS + maxTaskAttempts));
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/HamaMessageManagerImpl.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/message/HamaMessageManagerImpl.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/HamaMessageManagerImpl.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/HamaMessageManagerImpl.java
Fri May 30 07:12:15 2014
@@ -124,7 +124,7 @@ public final class HamaMessageManagerImp
}
/**
- * @param addr, socket address to which BSP Peer Connection will be
+ * @param addr socket address to which BSP Peer Connection will be
* established
* @return BSP Peer Connection, tried to return cached connection, else
* returns a new connection and caches it
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/MessageManagerFactory.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/message/MessageManagerFactory.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/MessageManagerFactory.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/MessageManagerFactory.java
Fri May 30 07:12:15 2014
@@ -28,7 +28,7 @@ public class MessageManagerFactory {
* Returns a messenger via reflection based on what was configured.
*
* @param conf
- * @return
+ * @return a messenger that was configured.
*/
@SuppressWarnings("unchecked")
public static <M extends Writable> MessageManager<M> getMessageManager(
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/BSPMessageCompressorFactory.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/BSPMessageCompressorFactory.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/BSPMessageCompressorFactory.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/BSPMessageCompressorFactory.java
Fri May 30 07:12:15 2014
@@ -29,7 +29,7 @@ public class BSPMessageCompressorFactory
* Returns a compressor via reflection based on what was configured.
*
* @param conf
- * @return
+ * @return a compressor that was configured.
*/
@SuppressWarnings("unchecked")
public BSPMessageCompressor<M> getCompressor(Configuration conf) {
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/Bzip2Compressor.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/Bzip2Compressor.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/Bzip2Compressor.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/Bzip2Compressor.java
Fri May 30 07:12:15 2014
@@ -65,8 +65,8 @@ public class Bzip2Compressor<M extends W
* Decompresses a BSPCompressedBundle and returns the corresponding
* BSPMessageBundle.
*
- * @param compMsgBundle
- * @return
+ * @param compressedBytes
+ * @return The result after decompressing BSPMessageBundle.
*/
@Override
public byte[] decompress(byte[] compressedBytes) {
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/SnappyCompressor.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/SnappyCompressor.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/SnappyCompressor.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/compress/SnappyCompressor.java
Fri May 30 07:12:15 2014
@@ -65,8 +65,8 @@ public class SnappyCompressor<M extends
* Decompresses a BSPCompressedBundle and returns the corresponding
* BSPMessageBundle.
*
- * @param compMsgBundle
- * @return
+ * @param compressedBytes
+ * @return The result after decompressing BSPCompressedBundle.
*/
@Override
public byte[] decompress(byte[] compressedBytes) {
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/ByteBufferOutputStream.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/ByteBufferOutputStream.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/ByteBufferOutputStream.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/ByteBufferOutputStream.java
Fri May 30 07:12:15 2014
@@ -102,7 +102,7 @@ class ByteBufferOutputStream extends Out
* Action to take when the data to be written exceeds the size of the byte
* buffer inside.
*
- * @return
+ * @return True
* @throws IOException
*/
protected boolean onBufferFull(byte[] b, int off, int len) throws
IOException {
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/SpillingDataOutputBuffer.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/SpillingDataOutputBuffer.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/SpillingDataOutputBuffer.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/message/io/SpillingDataOutputBuffer.java
Fri May 30 07:12:15 2014
@@ -480,7 +480,7 @@ public class SpillingDataOutputBuffer ex
* @param bufferSize
* @param threshold
* @param direct
- * @param fileName
+ * @param processor
*/
public SpillingDataOutputBuffer(int bufferCount, int bufferSize,
int threshold, boolean direct, SpilledDataProcessor processor) {
Modified: hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncClient.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncClient.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncClient.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncClient.java Fri
May 30 07:12:15 2014
@@ -47,7 +47,7 @@ public interface SyncClient {
* @param value The value to be stored.
* @param permanent true if the value should be persisted after end of
* session.
- * @param Listener object that provides asynchronous updates on the state of
+ * @param listener object that provides asynchronous updates on the state of
* information stored under the key.
* @return true if the operation was successful.
*/
@@ -58,7 +58,7 @@ public interface SyncClient {
* Retrieve value previously store for the key.
*
* @param key The key for which value was stored.
- * @param classType The expected class instance of value to be extracted
+ * @param valueHolder The expected class instance of value to be extracted
* @return the value if found. Returns null if there was any error of if
there
* was no value stored for the key.
*/
@@ -112,7 +112,7 @@ public interface SyncClient {
*
* @param key
* @param listener
- * @return
+ * @return true if the operation is successful.
*/
public boolean remove(String key, SyncEventListener listener);
Modified: hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncServer.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncServer.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncServer.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/SyncServer.java Fri
May 30 07:12:15 2014
@@ -37,7 +37,7 @@ public interface SyncServer {
* hostname:port.
*
* @param conf
- * @return
+ * @return the configuration of sync server.
*/
public Configuration init(Configuration conf) throws Exception;
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZKSyncClient.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZKSyncClient.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZKSyncClient.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZKSyncClient.java
Fri May 30 07:12:15 2014
@@ -183,7 +183,7 @@ public abstract class ZKSyncClient imple
* Utility function to read Writable object value from byte array.
*
* @param data The byte array
- * @param classType The Class object of expected Writable object.
+ * @param valueHolder The Class object of expected Writable object.
* @return The instance of Writable object.
* @throws IOException
*/
@@ -206,7 +206,7 @@ public abstract class ZKSyncClient imple
* Read value stored in the Zookeeper node.
*
* @param path The path of the Zookeeper node.
- * @param classType The expected class type of the Writable object.
+ * @param valueHolder The expected class type of the Writable object.
* @return The Writable object constructed from the value read from the
* Zookeeper node.
*/
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZooKeeperSyncClientImpl.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZooKeeperSyncClientImpl.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZooKeeperSyncClientImpl.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/sync/ZooKeeperSyncClientImpl.java
Fri May 30 07:12:15 2014
@@ -255,9 +255,7 @@ public class ZooKeeperSyncClientImpl ext
* Registers the task from outside, most of the time used by the groom which
* uses this at task spawn-time.
*
- * @param zk
* @param jobId
- * @param taskId
* @param hostAddress
* @param port
* @param taskId
Modified:
hama/trunk/core/src/main/java/org/apache/hama/bsp/taskallocation/BestEffortDataLocalTaskAllocator.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/bsp/taskallocation/BestEffortDataLocalTaskAllocator.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/core/src/main/java/org/apache/hama/bsp/taskallocation/BestEffortDataLocalTaskAllocator.java
(original)
+++
hama/trunk/core/src/main/java/org/apache/hama/bsp/taskallocation/BestEffortDataLocalTaskAllocator.java
Fri May 30 07:12:15 2014
@@ -47,7 +47,7 @@ public class BestEffortDataLocalTaskAllo
*
* @param grooms
* @param tasksInGroomMap
- * @return
+ * @return a hostname of Groom Server.
*/
private static String getAnyGroomToSchedule(
Map<String, GroomServerStatus> grooms,
@@ -73,7 +73,7 @@ public class BestEffortDataLocalTaskAllo
* @param grooms
* @param tasksInGroomMap
* @param possibleLocations
- * @return
+ * @return a hostname of Groom Server.
*/
private String getGroomToSchedule(Map<String, GroomServerStatus> grooms,
Map<GroomServerStatus, Integer> tasksInGroomMap,
Modified: hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java
URL:
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java Fri May
30 07:12:15 2014
@@ -181,7 +181,7 @@ public class BSPNetUtils {
/**
* Create a socket address with the given host and port. The hostname might
be
* replaced with another host that was set via
- * {@link #addStaticResolution(String, String)}. The value of
+ * {@link NetUtils#addStaticResolution(String, String)}. The value of
* hadoop.security.token.service.use_ip will determine whether the standard
* java host resolver is used, or if the fully qualified resolver is used.
*
Modified:
hama/trunk/graph/src/main/java/org/apache/hama/graph/AggregationRunner.java
URL:
http://svn.apache.org/viewvc/hama/trunk/graph/src/main/java/org/apache/hama/graph/AggregationRunner.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/graph/src/main/java/org/apache/hama/graph/AggregationRunner.java
(original)
+++ hama/trunk/graph/src/main/java/org/apache/hama/graph/AggregationRunner.java
Fri May 30 07:12:15 2014
@@ -130,7 +130,7 @@ public final class AggregationRunner<V e
* computation.
*
* @param lastValue the value before compute().
- * @param v the vertex.
+ * @param value the vertex.
*/
public void aggregateVertex(int index, M lastValue, M value) {
if (isEnabled()) {
Modified: hama/trunk/graph/src/main/java/org/apache/hama/graph/Vertex.java
URL:
http://svn.apache.org/viewvc/hama/trunk/graph/src/main/java/org/apache/hama/graph/Vertex.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/graph/src/main/java/org/apache/hama/graph/Vertex.java (original)
+++ hama/trunk/graph/src/main/java/org/apache/hama/graph/Vertex.java Fri May 30
07:12:15 2014
@@ -379,7 +379,7 @@ public abstract class Vertex<V extends W
* index is defined by the order you set the aggregator classes in
* {@link GraphJob#setAggregatorClass(Class...)}. Index is starting at zero,
* so if you have a single aggregator you can retrieve it via
- * {@link #getLastAggregatedValue}(0).
+ * {@link GraphJobRunner#getLastAggregatedValue}(0).
*/
@SuppressWarnings("unchecked")
@Override
Modified:
hama/trunk/graph/src/main/java/org/apache/hama/graph/VertexInterface.java
URL:
http://svn.apache.org/viewvc/hama/trunk/graph/src/main/java/org/apache/hama/graph/VertexInterface.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/graph/src/main/java/org/apache/hama/graph/VertexInterface.java
(original)
+++ hama/trunk/graph/src/main/java/org/apache/hama/graph/VertexInterface.java
Fri May 30 07:12:15 2014
@@ -118,7 +118,7 @@ public interface VertexInterface<V exten
*
* @throws IOException
*
- * @param name identifies a aggregator
+ * @param index identifies a aggregator
* @param value value to be aggregated
*/
public void aggregate(int index, M value) throws IOException;
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AbstractLayeredNeuralNetwork.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AbstractLayeredNeuralNetwork.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AbstractLayeredNeuralNetwork.java
(original)
+++
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AbstractLayeredNeuralNetwork.java
Fri May 30 07:12:15 2014
@@ -89,7 +89,7 @@ abstract class AbstractLayeredNeuralNetw
* Set the regularization weight. Recommend in the range [0, 0.1), More
* complex the model is, less weight the regularization is.
*
- * @param regularization
+ * @param regularizationWeight
*/
public void setRegularizationWeight(double regularizationWeight) {
Preconditions.checkArgument(regularizationWeight >= 0
@@ -136,7 +136,7 @@ abstract class AbstractLayeredNeuralNetw
/**
* Set the cost function for the model.
*
- * @param costFunctionName
+ * @param costFunction
*/
public void setCostFunction(DoubleDoubleFunction costFunction) {
this.costFunction = costFunction;
@@ -160,7 +160,7 @@ abstract class AbstractLayeredNeuralNetw
* Get the size of a particular layer.
*
* @param layer
- * @return
+ * @return The layer size.
*/
public int getLayerSize(int layer) {
Preconditions.checkArgument(
@@ -173,7 +173,7 @@ abstract class AbstractLayeredNeuralNetw
/**
* Get the layer size list.
*
- * @return
+ * @return The layer size list.
*/
protected List<Integer> getLayerSizeList() {
return this.layerSizeList;
@@ -201,7 +201,7 @@ abstract class AbstractLayeredNeuralNetw
* Get the output calculated by the model.
*
* @param instance The feature instance.
- * @return
+ * @return a new vector with the result of the operation.
*/
public abstract DoubleVector getOutput(DoubleVector instance);
@@ -210,7 +210,6 @@ abstract class AbstractLayeredNeuralNetw
*
* @param labels
* @param output
- * @return
*/
protected abstract void calculateTrainingError(DoubleVector labels,
DoubleVector output);
Modified: hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AutoEncoder.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AutoEncoder.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AutoEncoder.java
(original)
+++ hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/AutoEncoder.java Fri May
30 07:12:15 2014
@@ -109,7 +109,7 @@ public class AutoEncoder {
/**
* Get the matrix M used to encode the input features.
*
- * @return
+ * @return this matrix with encode the input.
*/
public DoubleMatrix getEncodeWeightMatrix() {
return model.getWeightsByLayer(0);
@@ -118,7 +118,7 @@ public class AutoEncoder {
/**
* Get the matrix M used to decode the compressed information.
*
- * @return
+ * @return this matrix with decode the compressed information.
*/
public DoubleMatrix getDecodeWeightMatrix() {
return model.getWeightsByLayer(1);
@@ -152,7 +152,7 @@ public class AutoEncoder {
/**
* Encode the input instance.
* @param inputInstance
- * @return
+ * @return a new vector with the encode input instance.
*/
public DoubleVector encode(DoubleVector inputInstance) {
Preconditions
@@ -166,7 +166,7 @@ public class AutoEncoder {
/**
* Decode the input instance.
* @param inputInstance
- * @return
+ * @return a new vector with the decode input instance.
*/
public DoubleVector decode(DoubleVector inputInstance) {
Preconditions
@@ -180,7 +180,7 @@ public class AutoEncoder {
/**
* Get the label(s) according to the given features.
* @param inputInstance
- * @return
+ * @return a new vector with output of the model according to given feature
instance.
*/
public DoubleVector getOutput(DoubleVector inputInstance) {
return model.getOutput(inputInstance);
Modified: hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/NeuralNetwork.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/NeuralNetwork.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/NeuralNetwork.java
(original)
+++ hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/NeuralNetwork.java Fri
May 30 07:12:15 2014
@@ -159,7 +159,6 @@ abstract class NeuralNetwork implements
/**
* Write the model data to specified location.
*
- * @param modelPath The location in file system to store the model.
* @throws IOException
*/
public void writeModelToFile() throws IOException {
@@ -191,7 +190,7 @@ abstract class NeuralNetwork implements
/**
* Get the model path.
*
- * @return
+ * @return the path to store the model.
*/
public String getModelPath() {
return this.modelPath;
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/SmallLayeredNeuralNetwork.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/SmallLayeredNeuralNetwork.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/SmallLayeredNeuralNetwork.java
(original)
+++
hama/trunk/ml/src/main/java/org/apache/hama/ml/ann/SmallLayeredNeuralNetwork.java
Fri May 30 07:12:15 2014
@@ -165,7 +165,7 @@ public class SmallLayeredNeuralNetwork e
/**
* Get all the weight matrices.
*
- * @return
+ * @return The matrices in form of matrix array.
*/
DoubleMatrix[] getWeightMatrices() {
DoubleMatrix[] matrices = new DoubleMatrix[this.weightMatrixList.size()];
@@ -186,7 +186,7 @@ public class SmallLayeredNeuralNetwork e
/**
* Get the previous matrices updates in form of array.
*
- * @return
+ * @return The matrices in form of matrix array.
*/
public DoubleMatrix[] getPrevMatricesUpdates() {
DoubleMatrix[] prevMatricesUpdates = new
DoubleMatrix[this.prevWeightUpdatesList
@@ -308,7 +308,7 @@ public class SmallLayeredNeuralNetwork e
*
* @param fromLayer The index of the previous layer.
* @param intermediateOutput The intermediateOutput of previous layer.
- * @return
+ * @return a new vector with the result of the operation.
*/
protected DoubleVector forward(int fromLayer, DoubleVector
intermediateOutput) {
DoubleMatrix weightMatrix = this.weightMatrixList.get(fromLayer);
@@ -457,7 +457,7 @@ public class SmallLayeredNeuralNetwork e
* @param layer Index of current layer.
* @param internalOutput Internal output of current layer.
* @param deltaVec Delta of next layer.
- * @return
+ * @return the squashing function of the specified position.
*/
private DoubleVector backpropagate(int curLayerIdx,
DoubleVector nextLayerDelta, List<DoubleVector> outputCache,
@@ -559,7 +559,7 @@ public class SmallLayeredNeuralNetwork e
* Get the squashing function of a specified layer.
*
* @param idx
- * @return
+ * @return a new vector with the result of the operation.
*/
public DoubleFunction getSquashingFunction(int idx) {
return this.squashingFunctionList.get(idx);
Modified: hama/trunk/ml/src/main/java/org/apache/hama/ml/kmeans/KMeansBSP.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/kmeans/KMeansBSP.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/ml/src/main/java/org/apache/hama/ml/kmeans/KMeansBSP.java
(original)
+++ hama/trunk/ml/src/main/java/org/apache/hama/ml/kmeans/KMeansBSP.java Fri
May 30 07:12:15 2014
@@ -430,7 +430,7 @@ public final class KMeansBSP
* @param out
* @param fs
* @param hasKey true if first column is required to be the key.
- * @return
+ * @return the path of a sequencefile.
* @throws IOException
*/
public static Path prepareInputText(int k, Configuration conf, Path txtIn,
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMLPMessage.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMLPMessage.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMLPMessage.java
(original)
+++
hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMLPMessage.java
Fri May 30 07:12:15 2014
@@ -64,7 +64,7 @@ public class SmallMLPMessage extends MLP
*
* @param owner The owner that create the message
* @param terminated Whether the training is terminated for the owner task
- * @param weightUpdatedMatrics The weight updates
+ * @param weightUpdatedMatrices The weight updates
* @param prevWeightUpdatedMatrices
*/
public SmallMLPMessage(int owner, boolean terminated,
@@ -79,7 +79,7 @@ public class SmallMLPMessage extends MLP
/**
* Get the owner task Id of the message.
*
- * @return
+ * @return the owner value.
*/
public int getOwner() {
return owner;
@@ -88,7 +88,7 @@ public class SmallMLPMessage extends MLP
/**
* Get the updated weight matrices.
*
- * @return
+ * @return the array value of dense double matrix object.
*/
public DenseDoubleMatrix[] getWeightUpdatedMatrices() {
return this.weightUpdatedMatrices;
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMultiLayerPerceptron.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMultiLayerPerceptron.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMultiLayerPerceptron.java
(original)
+++
hama/trunk/ml/src/main/java/org/apache/hama/ml/perception/SmallMultiLayerPerceptron.java
Fri May 30 07:12:15 2014
@@ -75,7 +75,7 @@ public final class SmallMultiLayerPercep
private DenseDoubleMatrix[] prevWeightUpdateMatrices;
/**
- * {@inheritDoc}
+ * @see MultiLayerPerceptron#MultiLayerPerceptron(double, double, double,
String, String, int[])
*/
public SmallMultiLayerPerceptron(double learningRate, double regularization,
double momentum, String squashingFunctionName, String costFunctionName,
@@ -87,7 +87,7 @@ public final class SmallMultiLayerPercep
}
/**
- * {@inheritDoc}
+ * @see MultiLayerPerceptron#MultiLayerPerceptron(String)
*/
public SmallMultiLayerPerceptron(String modelPath) {
super(modelPath);
@@ -202,7 +202,7 @@ public final class SmallMultiLayerPercep
*
* @param fromLayer The index of layer that forwards the intermediate results
* from.
- * @return
+ * @return the value of intermediate results of layer.
*/
private double[] forward(int fromLayer, double[] intermediateResult) {
int toLayer = fromLayer + 1;
@@ -549,7 +549,7 @@ public final class SmallMultiLayerPercep
* Print out the weights.
*
* @param mat
- * @return
+ * @return the weights value.
*/
static String weightsToString(DenseDoubleMatrix[] mat) {
StringBuilder sb = new StringBuilder();
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/recommendation/Recommender.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/recommendation/Recommender.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/ml/src/main/java/org/apache/hama/ml/recommendation/Recommender.java
(original)
+++
hama/trunk/ml/src/main/java/org/apache/hama/ml/recommendation/Recommender.java
Fri May 30 07:12:15 2014
@@ -42,8 +42,8 @@ public interface Recommender {
* load model from given path
* @param path - path of saved model
* @param lazy - some models are bigger than available memory,
- * set this to {@value true} if memory is less than data model
- * for faster prediction, set to {@value false} if using
+ * set this to <tt>true<tt> if memory is less than data model
+ * for faster prediction, set to <tt>false<tt> if using
* file access and reading from file is fine in prediction
phase
* @return true if success
*/
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LinearRegression.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LinearRegression.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LinearRegression.java
(original)
+++
hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LinearRegression.java
Fri May 30 07:12:15 2014
@@ -84,7 +84,7 @@ public class LinearRegression {
/**
* Get the weight of momemtum.
*
- * @return
+ * @return the monemtum weight value.
*/
public double getMomemtumWeight() {
return ann.getMomemtumWeight();
@@ -104,7 +104,7 @@ public class LinearRegression {
/**
* Get the weight of regularization.
*
- * @return
+ * @return the regularizatioin weight value.
*/
public double getRegularizationWeight() {
return ann.getRegularizationWeight();
@@ -141,7 +141,7 @@ public class LinearRegression {
* Get the output according to given input instance.
*
* @param instance
- * @return
+ * @return a new vector with the result of the operation.
*/
public DoubleVector getOutput(DoubleVector instance) {
return ann.getOutput(instance);
@@ -171,7 +171,7 @@ public class LinearRegression {
/**
* Get the weights of the model.
*
- * @return
+ * @return a new vector with the weights of the model.
*/
public DoubleVector getWeights() {
return ann.getWeightsByLayer(0).getRowVector(0);
@@ -179,7 +179,7 @@ public class LinearRegression {
/**
* Set the feature transformer.
- * @param transformer
+ * @param featureTransformer
*/
public void setFeatureTransformer(FeatureTransformer featureTransformer) {
this.ann.setFeatureTransformer(featureTransformer);
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LogisticRegression.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LogisticRegression.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LogisticRegression.java
(original)
+++
hama/trunk/ml/src/main/java/org/apache/hama/ml/regression/LogisticRegression.java
Fri May 30 07:12:15 2014
@@ -80,7 +80,7 @@ public class LogisticRegression {
/**
* Get the weight of momemtum.
*
- * @return
+ * @return the monemtum weight value.
*/
public double getMomemtumWeight() {
return ann.getMomemtumWeight();
@@ -100,7 +100,7 @@ public class LogisticRegression {
/**
* Get the weight of regularization.
*
- * @return
+ * @return the regularizatioin weight value.
*/
public double getRegularizationWeight() {
return ann.getRegularizationWeight();
@@ -134,7 +134,7 @@ public class LogisticRegression {
* Get the output according to given input instance.
*
* @param instance
- * @return
+ * @return a new vector with the result of the operation.
*/
public DoubleVector getOutput(DoubleVector instance) {
return ann.getOutput(instance);
@@ -164,7 +164,7 @@ public class LogisticRegression {
/**
* Get the weights of the model.
*
- * @return
+ * @return a new vector with the weights of the model.
*/
public DoubleVector getWeights() {
return ann.getWeightsByLayer(0).getRowVector(0);
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/semiclustering/SemiClusteringVertex.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/semiclustering/SemiClusteringVertex.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
---
hama/trunk/ml/src/main/java/org/apache/hama/ml/semiclustering/SemiClusteringVertex.java
(original)
+++
hama/trunk/ml/src/main/java/org/apache/hama/ml/semiclustering/SemiClusteringVertex.java
Fri May 30 07:12:15 2014
@@ -146,7 +146,7 @@ public class SemiClusteringVertex extend
* Function to calcualte the Score of a semi-cluster
*
* @param message
- * @return
+ * @return the value to calcualte the Score of a semi-cluster.
*/
public double semiClusterScoreCalcuation(SemiClusterMessage message) {
double iC = 0.0, bC = 0.0, fB = 0.0, sC = 0.0;
Modified:
hama/trunk/ml/src/main/java/org/apache/hama/ml/util/FeatureTransformer.java
URL:
http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/util/FeatureTransformer.java?rev=1598471&r1=1598470&r2=1598471&view=diff
==============================================================================
--- hama/trunk/ml/src/main/java/org/apache/hama/ml/util/FeatureTransformer.java
(original)
+++ hama/trunk/ml/src/main/java/org/apache/hama/ml/util/FeatureTransformer.java
Fri May 30 07:12:15 2014
@@ -33,8 +33,8 @@ public abstract class FeatureTransformer
/**
* Transform the original features to transformed space.
- * @param originalFeatureVector
- * @return
+ * @param originalFeatures
+ * @return a new vector with the result of the operation.
*/
public abstract DoubleVector transform(DoubleVector originalFeatures);
