Improved converters doc

shogun-toolbox · Oct 13, 2011 · 6e41476 · 6e41476
1 parent 864758f
commit 6e41476
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 10 deletions.
diff --git a/src/shogun/converter/Converter.h b/src/shogun/converter/Converter.h
@@ -5,7 +5,7 @@
  * (at your option) any later version.
  *
  * Written (W) 2011 Sergey Lisitsyn
- * Copyright (C) 2011
+ * Copyright (C) 2011 Sergey Lisitsyn
  */
 
 #ifndef CONVERTER_H_
@@ -18,17 +18,23 @@
 namespace shogun
 {
 
-/** @brief
- *
+/** @brief class Converter used to convert data
+ * 
  */
 class CConverter : public CSGObject
 {
 public:
+	/* constructor */
 	CConverter() : CSGObject() {};
+	/* destructor */
 	virtual ~CConverter() {};
-
+	/* get name */
 	virtual const char* get_name() const { return "Converter"; }
-
+	/* applies to the given data, returning converted features 
+	 * (e.g. dense embedding of string features)
+	 * @param features features to convert
+	 * @return converted features
+	 */
 	virtual CFeatures* apply(CFeatures* features) = 0;
 };
 }

diff --git a/src/shogun/converter/EmbeddingConverter.cpp b/src/shogun/converter/EmbeddingConverter.cpp
@@ -5,7 +5,7 @@
  * (at your option) any later version.
  *
  * Written (W) 2011 Sergey Lisitsyn
- * Copyright (C) 2011 
+ * Copyright (C) 2011 Sergey Lisitsyn
  */
 
 #include <shogun/converter/EmbeddingConverter.h>

diff --git a/src/shogun/converter/EmbeddingConverter.h b/src/shogun/converter/EmbeddingConverter.h
@@ -5,7 +5,7 @@
  * (at your option) any later version.
  *
  * Written (W) 2011 Sergey Lisitsyn
- * Copyright (C) 2011
+ * Copyright (C) 2011 Sergey Lisitsyn
  */
 
 #ifndef EMBEDDINGCONVERTER_H_
@@ -24,17 +24,23 @@ class CFeatures;
 class CDistance;
 class CKernel;
 
-/** @brief */
+/** @brief class EmbeddingConverter used to create embeddings of 
+ * features, e.g. construct dense numeric embedding of string features
+ */
 class CEmbeddingConverter: public CConverter
 {
 public:
 
-	/* constructor */
+	/** constructor */
 	CEmbeddingConverter();
 
-	/* destructor */
+	/** destructor */
 	virtual ~CEmbeddingConverter();
 
+	/** applies to the given data, returns embedding
+	 * @param features features to embed
+	 * @return embedding simple features
+	 */
 	virtual CSimpleFeatures<float64_t>* apply(CFeatures* features) = 0;
 
 	/** setter for target dimension