README.md

   1 ## GenericClassifier on Tizen\r
   2 \r
   3 * The given project classifies text into 15 categories\r
   4 * Recommended Tizen Version: 5.0\r
   5 * Recommended Platform Image version : TIZEN-5.0-need to be updated\r
   6 \r
   7 ## Module mapping with Source files\r
   8 \r
   9 * GenericClassifier consist of following APIs\r
  10   * text_classifier_initialize()\r
  11   * text_classifier_deinitialize()\r
  12   * text_classifier_create()\r
  13   * text_classifier_delete()\r
  14   * text_classifier_get_category()\r
  15   * text_classifier_add_category()\r
  16   * text_classifier_delete_category()\r
  17   * text_classifier_update_category()\r
  18 \r
  19 * src folder contains all the module implementation\r
  20   * persistentStorage.cpp contains the functionality for database handling.\r
  21   * dataPreprocessing.cpp processes upon the raw text to extract important words which would be used for classification.\r
  22   * Classifier.cpp implments the logic for classifying text into predefined categories.\r
  23   * generic_classifier.c exposes the APIs. \r
  24 * Header files corresponding to modules are put in include folder,  \r
  25   API description corresponding to module is provided in corresponding header file.\r
  26 \r
  27 ## GenericClassifier on Tizen build steps\r
  28 * Step 1: Build "Generic Text Classifier on Tizen" Project\r
  29   * Get the source codes\r
  30   ```console\r
  31   $ git clone https://review.tizen.org/gerrit/p/platform/core/api/generic-text-classifier\r
  32   $ cd generic_text_classifier\r
  33   ```\r
  34   * Build "GenericTextClassifier on Tizen" Project\r
  35   ```console\r
  36   $ gbs build --include-all -A armv7l\r
  37   ```\r
  38   * Install the rpm created generic_text_classifier by using the command "rpm -Uvh --force --nodeps <rpm_name>".\r
  39   * When above rpm is installed on a Tizen device, libgeneric_text_classifier.so will be created at the path "/usr/lib".\r
  40 \r
  41   * To build and run the gc_unit_test test applications applications, the following build command needs to be used\r
  42   ```console\r
  43   $ gbs build --include-all -A armv7l --define 'enable_test "Y"'\r
  44   ```\r
  45 ## Running test application for GenericClassifier on Tizen\r
  46   * Run the application unit test application "/usr/bin/gc_unit_test".\r
  47 \r