hana_ml.text package ==================== This package contains a collection of algorithms for text related class and functions like text analysis, text mining and text chunking. .. note:: If you wish to use Text Mining related functions, please be aware that the functionalities included in HANA On-Premise and HANA Cloud's Text Mining significantly vary. The functions supported by HANA On-Premise and HANA Cloud and the reference link are listed below. In order to support both HANA On-Premise and HANA Cloud, hana_ml uses the same function name for the same functionality. For instance, 'text_classification' could map to the 'TM_CATEGORIZE_KNN' SQL procedure in HANA On-Premise, and 'PAL_TEXTCLASSIFICATION' in HANA Cloud. Moreover, certain parameters might be marked as only supported by HANA On-Premise. If the HANA system you're using doesn't support certain functions and yet you attempt to use them, an error will be thrown. 1. **HANA On-Premise** Text mining - :func:`~hana_ml.text.tm.text_classification` (`TM_CATEGORIZE_KNN `_) - :class:`~hana_ml.text.tm.TextClassificationWithModel` (`PAL_TEXTCLASSIFICATION_TRAIN `_/`PAL_TEXTCLASSIFICATION_PREDICT `_) supported in HANA 2.0 SPS08. - :class:`~hana_ml.text.tm.TFIDF` (`PAL_TEXT_COLLECT/PAL_TEXT_TFIDF `_ ) supported since HANA 2.0 SPS07. - :func:`~hana_ml.text.tm.get_related_doc` (`TM_GET_RELATED_DOCUMENTS `_) - :func:`~hana_ml.text.tm.get_related_term` (`TM_GET_RELATED_TERMS `_) - :func:`~hana_ml.text.tm.get_relevant_doc` (`TM_GET_RELEVANT_DOCUMENTS `_) - :func:`~hana_ml.text.tm.get_relevant_term` (`TM_GET_RELEVANT_TERMS `_) - :func:`~hana_ml.text.tm.get_suggested_term` (`TM_GET_SUGGESTED_TERMS `_) 2. **HANA Cloud** Text mining - :func:`~hana_ml.text.tm.text_classification` (`PAL_TEXTCLASSIFICATION `_) - :class:`~hana_ml.text.tm.TextClassificationWithModel` (`PAL_TEXTCLASSIFICATION_TRAIN `_/`PAL_TEXTCLASSIFICATION_PREDICT `_) - :func:`~hana_ml.text.tm.tf_analysis` (`PAL_TF_ANALYSIS `_) - :class:`~hana_ml.text.tm.TFIDF` (`PAL_TEXT_COLLECT/PAL_TEXT_TFIDF `_ ) - :func:`~hana_ml.text.tm.get_related_doc` (`PAL_TMGETRELATEDDOC `_) - :func:`~hana_ml.text.tm.get_related_term` (`PAL_TMGETRELATEDTERM `_) - :func:`~hana_ml.text.tm.get_relevant_doc` (`PAL_TMGETRELEVANTDOC `_) - :func:`~hana_ml.text.tm.get_relevant_term` (`PAL_TMGETRELEVANTTERM `_) - :func:`~hana_ml.text.tm.get_suggested_term` (`PAL_TMGETSUGGESTEDTERM `_) - :func:`~hana_ml.text.tm.search_docs_by_keywords` (`PAL_SEARCH_DOCS_BY_KEYWORDS `_) - :class:`~hana_ml.text.anns_model.ANNSModel` (`PAL_ANNS_MODEL_CREATE_BY_VECTOR/PAL_ANNS_MODEL_CREATE_BY_DOC `_) The algorithms are distributed into the following sub-packages. .. automodule:: hana_ml.text :no-members: :no-inherited-members: .. _text_tm-label: .. currentmodule:: hana_ml.text hana_ml.text.tm --------------- .. autosummary:: :toctree: text/ :template: function.rst tm.tf_analysis tm.text_classification tm.get_related_doc tm.get_related_term tm.get_relevant_doc tm.get_relevant_term tm.get_suggested_term tm.search_docs_by_keywords .. autosummary:: :toctree: text/ :template: class.rst tm.TFIDF tm.TextClassificationWithModel .. _text_anns_model-label: .. currentmodule:: hana_ml.text hana_ml.text.anns_model ----------------------- .. autosummary:: :toctree: text/ :template: class.rst anns_model.ANNSModel .. autosummary:: :toctree: text/ :template: function.rst anns_model.list_models .. _text_pal_embeddings-label: .. currentmodule:: hana_ml.text hana_ml.text.pal_embeddings --------------------------- .. autosummary:: :toctree: text/ :template: class.rst pal_embeddings.PALEmbeddings .. _text_splitter-label: .. currentmodule:: hana_ml.text hana_ml.text.text_splitter -------------------------- .. autosummary:: :toctree: text/ :template: class.rst text_splitter.TextSplitter