ngram_counter.hpp

/* Copyright © 2017 Apple Inc. All rights reserved.
 *
 * Use of this source code is governed by a BSD-3-clause license that can
 * be found in the LICENSE.txt file or at https://opensource.org/licenses/BSD-3-Clause
 */
#ifndef TURI_FE_ngram_counter_H_
#define TURI_FE_ngram_counter_H_
#include <model_server/lib/toolkit_class_macros.hpp>
#include <toolkits/feature_engineering/transformer_base.hpp>
#include <toolkits/feature_engineering/transform_utils.hpp>
#include <core/export.hpp>

namespace turi {
namespace sdk_model {
namespace feature_engineering {

class EXPORT ngram_counter: public transformer_base {

  static constexpr size_t NGRAM_COUNTER_VERSION = 0;
  size_t n = 2;
  bool fitted = false;
  bool to_lower = true;
  bool ignore_punct = true;
  bool ignore_space = true;
  bool exclude = false;
  std::map<std::string, flex_type_enum> feature_types;
  std::vector<std::string> feature_columns;
  flexible_type unprocessed_features;      // List of feature columns provided by the user.
  flexible_type delimiters;                // List of delimiters provided by the user.
  flex_string ngram_type;

  private:
  transform_utils::string_filter_list string_filters;

  void set_string_filters();

  public:
  /**
   * Methods that must be implemented in a new transformer model.
   * -------------------------------------------------------------------------
   */

  virtual inline ~ngram_counter() {}

  /**
   * Set one of the options in the model. Use the option manager to set
   * these options. If the option does not satisfy the conditions that the
   * option manager has imposed on it. Errors will be thrown.
   *
   * \param[in] options Options to set
   */
  void init_options(const std::map<std::string, flexible_type>&_options) override;
  /**
   * Set constant.
   *
   * \param[in] data  (SFrame of data)
   */
  size_t get_version() const override;

  /**
   * Save the object using Turi's oarc.
   */
  void save_impl(turi::oarchive& oarc) const override;

  /**
   * Load the object using Turi's iarc.
   */
  void load_version(turi::iarchive& iarc, size_t version) override;


  /**
   * Initialize the transformer.
   */
  void init_transformer(const std::map<std::string,
                        flexible_type>& _options) override;

  /**
   * Set constant.
   *
   * \param[in] data  (SFrame of data)
   */
  void fit(gl_sframe data) override;

  /**
   * Transform the given data.
   *
   * \param[in] data  (SFrame of data)
   *
   * Python side interface
   * ------------------------
   * This function directly interfaces with "transform" in python.
   *
   */
  gl_sframe transform(gl_sframe data) override;

  /**
   * Fit and transform the given data. Intended as an optimization because
   * fit and transform are usually always called together. The default
   * implementaiton calls fit and then transform.
   *
   * \param[in] data  (SFrame of data)
   */
  gl_sframe fit_transform(gl_sframe data) {
    data.materialize();
    fit(data);
    return transform(data);
  }

  // Functions that all transformers need to register. Can be copied verbatim
  // for other classes.
  // --------------------------------------------------------------------------
  BEGIN_CLASS_MEMBER_REGISTRATION("_NGramCounter")
  REGISTER_CLASS_MEMBER_FUNCTION(ngram_counter::init_transformer, "_options");
  REGISTER_CLASS_MEMBER_FUNCTION(ngram_counter::fit, "data");
  REGISTER_CLASS_MEMBER_FUNCTION(ngram_counter::fit_transform, "data");
  REGISTER_CLASS_MEMBER_FUNCTION(ngram_counter::transform, "data");
  REGISTER_CLASS_MEMBER_FUNCTION(ngram_counter::get_current_options);
  REGISTER_CLASS_MEMBER_FUNCTION(ngram_counter::list_fields);
  REGISTER_NAMED_CLASS_MEMBER_FUNCTION("_get_default_options",
                                     ngram_counter::get_default_options);
  REGISTER_NAMED_CLASS_MEMBER_FUNCTION("get",
                                     ngram_counter::get_value_from_state,
                                     "key");
  END_CLASS_MEMBER_REGISTRATION

};

} // feature_engineering
} // sdk_model
} // turicreate

#endif