spark-nlp 2.6.3rc1__py2.py3-none-any.whl → 6.2.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- com/johnsnowlabs/ml/__init__.py +0 -0
- com/johnsnowlabs/ml/ai/__init__.py +10 -0
- com/johnsnowlabs/nlp/__init__.py +4 -2
- spark_nlp-6.2.1.dist-info/METADATA +362 -0
- spark_nlp-6.2.1.dist-info/RECORD +292 -0
- {spark_nlp-2.6.3rc1.dist-info → spark_nlp-6.2.1.dist-info}/WHEEL +1 -1
- sparknlp/__init__.py +281 -27
- sparknlp/annotation.py +137 -6
- sparknlp/annotation_audio.py +61 -0
- sparknlp/annotation_image.py +82 -0
- sparknlp/annotator/__init__.py +93 -0
- sparknlp/annotator/audio/__init__.py +16 -0
- sparknlp/annotator/audio/hubert_for_ctc.py +188 -0
- sparknlp/annotator/audio/wav2vec2_for_ctc.py +161 -0
- sparknlp/annotator/audio/whisper_for_ctc.py +251 -0
- sparknlp/annotator/chunk2_doc.py +85 -0
- sparknlp/annotator/chunker.py +137 -0
- sparknlp/annotator/classifier_dl/__init__.py +61 -0
- sparknlp/annotator/classifier_dl/albert_for_multiple_choice.py +161 -0
- sparknlp/annotator/classifier_dl/albert_for_question_answering.py +172 -0
- sparknlp/annotator/classifier_dl/albert_for_sequence_classification.py +201 -0
- sparknlp/annotator/classifier_dl/albert_for_token_classification.py +179 -0
- sparknlp/annotator/classifier_dl/albert_for_zero_shot_classification.py +211 -0
- sparknlp/annotator/classifier_dl/bart_for_zero_shot_classification.py +225 -0
- sparknlp/annotator/classifier_dl/bert_for_multiple_choice.py +161 -0
- sparknlp/annotator/classifier_dl/bert_for_question_answering.py +168 -0
- sparknlp/annotator/classifier_dl/bert_for_sequence_classification.py +202 -0
- sparknlp/annotator/classifier_dl/bert_for_token_classification.py +177 -0
- sparknlp/annotator/classifier_dl/bert_for_zero_shot_classification.py +212 -0
- sparknlp/annotator/classifier_dl/camembert_for_question_answering.py +168 -0
- sparknlp/annotator/classifier_dl/camembert_for_sequence_classification.py +205 -0
- sparknlp/annotator/classifier_dl/camembert_for_token_classification.py +173 -0
- sparknlp/annotator/classifier_dl/camembert_for_zero_shot_classification.py +202 -0
- sparknlp/annotator/classifier_dl/classifier_dl.py +320 -0
- sparknlp/annotator/classifier_dl/deberta_for_question_answering.py +168 -0
- sparknlp/annotator/classifier_dl/deberta_for_sequence_classification.py +198 -0
- sparknlp/annotator/classifier_dl/deberta_for_token_classification.py +175 -0
- sparknlp/annotator/classifier_dl/deberta_for_zero_shot_classification.py +193 -0
- sparknlp/annotator/classifier_dl/distil_bert_for_question_answering.py +168 -0
- sparknlp/annotator/classifier_dl/distil_bert_for_sequence_classification.py +201 -0
- sparknlp/annotator/classifier_dl/distil_bert_for_token_classification.py +175 -0
- sparknlp/annotator/classifier_dl/distil_bert_for_zero_shot_classification.py +211 -0
- sparknlp/annotator/classifier_dl/distilbert_for_multiple_choice.py +161 -0
- sparknlp/annotator/classifier_dl/longformer_for_question_answering.py +168 -0
- sparknlp/annotator/classifier_dl/longformer_for_sequence_classification.py +201 -0
- sparknlp/annotator/classifier_dl/longformer_for_token_classification.py +176 -0
- sparknlp/annotator/classifier_dl/mpnet_for_question_answering.py +148 -0
- sparknlp/annotator/classifier_dl/mpnet_for_sequence_classification.py +188 -0
- sparknlp/annotator/classifier_dl/mpnet_for_token_classification.py +173 -0
- sparknlp/annotator/classifier_dl/multi_classifier_dl.py +395 -0
- sparknlp/annotator/classifier_dl/roberta_for_multiple_choice.py +161 -0
- sparknlp/annotator/classifier_dl/roberta_for_question_answering.py +168 -0
- sparknlp/annotator/classifier_dl/roberta_for_sequence_classification.py +201 -0
- sparknlp/annotator/classifier_dl/roberta_for_token_classification.py +189 -0
- sparknlp/annotator/classifier_dl/roberta_for_zero_shot_classification.py +225 -0
- sparknlp/annotator/classifier_dl/sentiment_dl.py +378 -0
- sparknlp/annotator/classifier_dl/tapas_for_question_answering.py +170 -0
- sparknlp/annotator/classifier_dl/xlm_roberta_for_multiple_choice.py +149 -0
- sparknlp/annotator/classifier_dl/xlm_roberta_for_question_answering.py +168 -0
- sparknlp/annotator/classifier_dl/xlm_roberta_for_sequence_classification.py +201 -0
- sparknlp/annotator/classifier_dl/xlm_roberta_for_token_classification.py +173 -0
- sparknlp/annotator/classifier_dl/xlm_roberta_for_zero_shot_classification.py +225 -0
- sparknlp/annotator/classifier_dl/xlnet_for_sequence_classification.py +201 -0
- sparknlp/annotator/classifier_dl/xlnet_for_token_classification.py +176 -0
- sparknlp/annotator/cleaners/__init__.py +15 -0
- sparknlp/annotator/cleaners/cleaner.py +202 -0
- sparknlp/annotator/cleaners/extractor.py +191 -0
- sparknlp/annotator/coref/__init__.py +1 -0
- sparknlp/annotator/coref/spanbert_coref.py +221 -0
- sparknlp/annotator/cv/__init__.py +29 -0
- sparknlp/annotator/cv/blip_for_question_answering.py +172 -0
- sparknlp/annotator/cv/clip_for_zero_shot_classification.py +193 -0
- sparknlp/annotator/cv/convnext_for_image_classification.py +269 -0
- sparknlp/annotator/cv/florence2_transformer.py +180 -0
- sparknlp/annotator/cv/gemma3_for_multimodal.py +346 -0
- sparknlp/annotator/cv/internvl_for_multimodal.py +280 -0
- sparknlp/annotator/cv/janus_for_multimodal.py +351 -0
- sparknlp/annotator/cv/llava_for_multimodal.py +328 -0
- sparknlp/annotator/cv/mllama_for_multimodal.py +340 -0
- sparknlp/annotator/cv/paligemma_for_multimodal.py +308 -0
- sparknlp/annotator/cv/phi3_vision_for_multimodal.py +328 -0
- sparknlp/annotator/cv/qwen2vl_transformer.py +332 -0
- sparknlp/annotator/cv/smolvlm_transformer.py +426 -0
- sparknlp/annotator/cv/swin_for_image_classification.py +242 -0
- sparknlp/annotator/cv/vision_encoder_decoder_for_image_captioning.py +240 -0
- sparknlp/annotator/cv/vit_for_image_classification.py +217 -0
- sparknlp/annotator/dataframe_optimizer.py +216 -0
- sparknlp/annotator/date2_chunk.py +88 -0
- sparknlp/annotator/dependency/__init__.py +17 -0
- sparknlp/annotator/dependency/dependency_parser.py +294 -0
- sparknlp/annotator/dependency/typed_dependency_parser.py +318 -0
- sparknlp/annotator/document_character_text_splitter.py +228 -0
- sparknlp/annotator/document_normalizer.py +235 -0
- sparknlp/annotator/document_token_splitter.py +175 -0
- sparknlp/annotator/document_token_splitter_test.py +85 -0
- sparknlp/annotator/embeddings/__init__.py +45 -0
- sparknlp/annotator/embeddings/albert_embeddings.py +230 -0
- sparknlp/annotator/embeddings/auto_gguf_embeddings.py +539 -0
- sparknlp/annotator/embeddings/bert_embeddings.py +208 -0
- sparknlp/annotator/embeddings/bert_sentence_embeddings.py +224 -0
- sparknlp/annotator/embeddings/bge_embeddings.py +199 -0
- sparknlp/annotator/embeddings/camembert_embeddings.py +210 -0
- sparknlp/annotator/embeddings/chunk_embeddings.py +149 -0
- sparknlp/annotator/embeddings/deberta_embeddings.py +208 -0
- sparknlp/annotator/embeddings/distil_bert_embeddings.py +221 -0
- sparknlp/annotator/embeddings/doc2vec.py +352 -0
- sparknlp/annotator/embeddings/e5_embeddings.py +195 -0
- sparknlp/annotator/embeddings/e5v_embeddings.py +138 -0
- sparknlp/annotator/embeddings/elmo_embeddings.py +251 -0
- sparknlp/annotator/embeddings/instructor_embeddings.py +204 -0
- sparknlp/annotator/embeddings/longformer_embeddings.py +211 -0
- sparknlp/annotator/embeddings/minilm_embeddings.py +189 -0
- sparknlp/annotator/embeddings/mpnet_embeddings.py +192 -0
- sparknlp/annotator/embeddings/mxbai_embeddings.py +184 -0
- sparknlp/annotator/embeddings/nomic_embeddings.py +181 -0
- sparknlp/annotator/embeddings/roberta_embeddings.py +225 -0
- sparknlp/annotator/embeddings/roberta_sentence_embeddings.py +191 -0
- sparknlp/annotator/embeddings/sentence_embeddings.py +134 -0
- sparknlp/annotator/embeddings/snowflake_embeddings.py +202 -0
- sparknlp/annotator/embeddings/uae_embeddings.py +211 -0
- sparknlp/annotator/embeddings/universal_sentence_encoder.py +211 -0
- sparknlp/annotator/embeddings/word2vec.py +353 -0
- sparknlp/annotator/embeddings/word_embeddings.py +385 -0
- sparknlp/annotator/embeddings/xlm_roberta_embeddings.py +225 -0
- sparknlp/annotator/embeddings/xlm_roberta_sentence_embeddings.py +194 -0
- sparknlp/annotator/embeddings/xlnet_embeddings.py +227 -0
- sparknlp/annotator/er/__init__.py +16 -0
- sparknlp/annotator/er/entity_ruler.py +267 -0
- sparknlp/annotator/graph_extraction.py +368 -0
- sparknlp/annotator/keyword_extraction/__init__.py +16 -0
- sparknlp/annotator/keyword_extraction/yake_keyword_extraction.py +270 -0
- sparknlp/annotator/ld_dl/__init__.py +16 -0
- sparknlp/annotator/ld_dl/language_detector_dl.py +199 -0
- sparknlp/annotator/lemmatizer.py +250 -0
- sparknlp/annotator/matcher/__init__.py +20 -0
- sparknlp/annotator/matcher/big_text_matcher.py +272 -0
- sparknlp/annotator/matcher/date_matcher.py +303 -0
- sparknlp/annotator/matcher/multi_date_matcher.py +109 -0
- sparknlp/annotator/matcher/regex_matcher.py +221 -0
- sparknlp/annotator/matcher/text_matcher.py +290 -0
- sparknlp/annotator/n_gram_generator.py +141 -0
- sparknlp/annotator/ner/__init__.py +21 -0
- sparknlp/annotator/ner/ner_approach.py +94 -0
- sparknlp/annotator/ner/ner_converter.py +148 -0
- sparknlp/annotator/ner/ner_crf.py +397 -0
- sparknlp/annotator/ner/ner_dl.py +591 -0
- sparknlp/annotator/ner/ner_dl_graph_checker.py +293 -0
- sparknlp/annotator/ner/ner_overwriter.py +166 -0
- sparknlp/annotator/ner/zero_shot_ner_model.py +173 -0
- sparknlp/annotator/normalizer.py +230 -0
- sparknlp/annotator/openai/__init__.py +16 -0
- sparknlp/annotator/openai/openai_completion.py +349 -0
- sparknlp/annotator/openai/openai_embeddings.py +106 -0
- sparknlp/annotator/param/__init__.py +17 -0
- sparknlp/annotator/param/classifier_encoder.py +98 -0
- sparknlp/annotator/param/evaluation_dl_params.py +130 -0
- sparknlp/annotator/pos/__init__.py +16 -0
- sparknlp/annotator/pos/perceptron.py +263 -0
- sparknlp/annotator/sentence/__init__.py +17 -0
- sparknlp/annotator/sentence/sentence_detector.py +290 -0
- sparknlp/annotator/sentence/sentence_detector_dl.py +467 -0
- sparknlp/annotator/sentiment/__init__.py +17 -0
- sparknlp/annotator/sentiment/sentiment_detector.py +208 -0
- sparknlp/annotator/sentiment/vivekn_sentiment.py +242 -0
- sparknlp/annotator/seq2seq/__init__.py +35 -0
- sparknlp/annotator/seq2seq/auto_gguf_model.py +304 -0
- sparknlp/annotator/seq2seq/auto_gguf_reranker.py +334 -0
- sparknlp/annotator/seq2seq/auto_gguf_vision_model.py +336 -0
- sparknlp/annotator/seq2seq/bart_transformer.py +420 -0
- sparknlp/annotator/seq2seq/cohere_transformer.py +357 -0
- sparknlp/annotator/seq2seq/cpm_transformer.py +321 -0
- sparknlp/annotator/seq2seq/gpt2_transformer.py +363 -0
- sparknlp/annotator/seq2seq/llama2_transformer.py +343 -0
- sparknlp/annotator/seq2seq/llama3_transformer.py +381 -0
- sparknlp/annotator/seq2seq/m2m100_transformer.py +392 -0
- sparknlp/annotator/seq2seq/marian_transformer.py +374 -0
- sparknlp/annotator/seq2seq/mistral_transformer.py +348 -0
- sparknlp/annotator/seq2seq/nllb_transformer.py +420 -0
- sparknlp/annotator/seq2seq/olmo_transformer.py +326 -0
- sparknlp/annotator/seq2seq/phi2_transformer.py +326 -0
- sparknlp/annotator/seq2seq/phi3_transformer.py +330 -0
- sparknlp/annotator/seq2seq/phi4_transformer.py +387 -0
- sparknlp/annotator/seq2seq/qwen_transformer.py +340 -0
- sparknlp/annotator/seq2seq/starcoder_transformer.py +335 -0
- sparknlp/annotator/seq2seq/t5_transformer.py +425 -0
- sparknlp/annotator/similarity/__init__.py +0 -0
- sparknlp/annotator/similarity/document_similarity_ranker.py +379 -0
- sparknlp/annotator/spell_check/__init__.py +18 -0
- sparknlp/annotator/spell_check/context_spell_checker.py +911 -0
- sparknlp/annotator/spell_check/norvig_sweeting.py +358 -0
- sparknlp/annotator/spell_check/symmetric_delete.py +299 -0
- sparknlp/annotator/stemmer.py +79 -0
- sparknlp/annotator/stop_words_cleaner.py +190 -0
- sparknlp/annotator/tf_ner_dl_graph_builder.py +179 -0
- sparknlp/annotator/token/__init__.py +19 -0
- sparknlp/annotator/token/chunk_tokenizer.py +118 -0
- sparknlp/annotator/token/recursive_tokenizer.py +205 -0
- sparknlp/annotator/token/regex_tokenizer.py +208 -0
- sparknlp/annotator/token/tokenizer.py +561 -0
- sparknlp/annotator/token2_chunk.py +76 -0
- sparknlp/annotator/ws/__init__.py +16 -0
- sparknlp/annotator/ws/word_segmenter.py +429 -0
- sparknlp/base/__init__.py +30 -0
- sparknlp/base/audio_assembler.py +95 -0
- sparknlp/base/doc2_chunk.py +169 -0
- sparknlp/base/document_assembler.py +164 -0
- sparknlp/base/embeddings_finisher.py +201 -0
- sparknlp/base/finisher.py +217 -0
- sparknlp/base/gguf_ranking_finisher.py +234 -0
- sparknlp/base/graph_finisher.py +125 -0
- sparknlp/base/has_recursive_fit.py +24 -0
- sparknlp/base/has_recursive_transform.py +22 -0
- sparknlp/base/image_assembler.py +172 -0
- sparknlp/base/light_pipeline.py +429 -0
- sparknlp/base/multi_document_assembler.py +164 -0
- sparknlp/base/prompt_assembler.py +207 -0
- sparknlp/base/recursive_pipeline.py +107 -0
- sparknlp/base/table_assembler.py +145 -0
- sparknlp/base/token_assembler.py +124 -0
- sparknlp/common/__init__.py +26 -0
- sparknlp/common/annotator_approach.py +41 -0
- sparknlp/common/annotator_model.py +47 -0
- sparknlp/common/annotator_properties.py +114 -0
- sparknlp/common/annotator_type.py +38 -0
- sparknlp/common/completion_post_processing.py +37 -0
- sparknlp/common/coverage_result.py +22 -0
- sparknlp/common/match_strategy.py +33 -0
- sparknlp/common/properties.py +1298 -0
- sparknlp/common/read_as.py +33 -0
- sparknlp/common/recursive_annotator_approach.py +35 -0
- sparknlp/common/storage.py +149 -0
- sparknlp/common/utils.py +39 -0
- sparknlp/functions.py +315 -5
- sparknlp/internal/__init__.py +1199 -0
- sparknlp/internal/annotator_java_ml.py +32 -0
- sparknlp/internal/annotator_transformer.py +37 -0
- sparknlp/internal/extended_java_wrapper.py +63 -0
- sparknlp/internal/params_getters_setters.py +71 -0
- sparknlp/internal/recursive.py +70 -0
- sparknlp/logging/__init__.py +15 -0
- sparknlp/logging/comet.py +467 -0
- sparknlp/partition/__init__.py +16 -0
- sparknlp/partition/partition.py +244 -0
- sparknlp/partition/partition_properties.py +902 -0
- sparknlp/partition/partition_transformer.py +200 -0
- sparknlp/pretrained/__init__.py +17 -0
- sparknlp/pretrained/pretrained_pipeline.py +158 -0
- sparknlp/pretrained/resource_downloader.py +216 -0
- sparknlp/pretrained/utils.py +35 -0
- sparknlp/reader/__init__.py +15 -0
- sparknlp/reader/enums.py +19 -0
- sparknlp/reader/pdf_to_text.py +190 -0
- sparknlp/reader/reader2doc.py +124 -0
- sparknlp/reader/reader2image.py +136 -0
- sparknlp/reader/reader2table.py +44 -0
- sparknlp/reader/reader_assembler.py +159 -0
- sparknlp/reader/sparknlp_reader.py +461 -0
- sparknlp/training/__init__.py +20 -0
- sparknlp/training/_tf_graph_builders/__init__.py +0 -0
- sparknlp/training/_tf_graph_builders/graph_builders.py +299 -0
- sparknlp/training/_tf_graph_builders/ner_dl/__init__.py +0 -0
- sparknlp/training/_tf_graph_builders/ner_dl/create_graph.py +41 -0
- sparknlp/training/_tf_graph_builders/ner_dl/dataset_encoder.py +78 -0
- sparknlp/training/_tf_graph_builders/ner_dl/ner_model.py +521 -0
- sparknlp/training/_tf_graph_builders/ner_dl/ner_model_saver.py +62 -0
- sparknlp/training/_tf_graph_builders/ner_dl/sentence_grouper.py +28 -0
- sparknlp/training/_tf_graph_builders/tf2contrib/__init__.py +36 -0
- sparknlp/training/_tf_graph_builders/tf2contrib/core_rnn_cell.py +385 -0
- sparknlp/training/_tf_graph_builders/tf2contrib/fused_rnn_cell.py +183 -0
- sparknlp/training/_tf_graph_builders/tf2contrib/gru_ops.py +235 -0
- sparknlp/training/_tf_graph_builders/tf2contrib/lstm_ops.py +665 -0
- sparknlp/training/_tf_graph_builders/tf2contrib/rnn.py +245 -0
- sparknlp/training/_tf_graph_builders/tf2contrib/rnn_cell.py +4006 -0
- sparknlp/training/_tf_graph_builders_1x/__init__.py +0 -0
- sparknlp/training/_tf_graph_builders_1x/graph_builders.py +277 -0
- sparknlp/training/_tf_graph_builders_1x/ner_dl/__init__.py +0 -0
- sparknlp/training/_tf_graph_builders_1x/ner_dl/create_graph.py +34 -0
- sparknlp/training/_tf_graph_builders_1x/ner_dl/dataset_encoder.py +78 -0
- sparknlp/training/_tf_graph_builders_1x/ner_dl/ner_model.py +532 -0
- sparknlp/training/_tf_graph_builders_1x/ner_dl/ner_model_saver.py +62 -0
- sparknlp/training/_tf_graph_builders_1x/ner_dl/sentence_grouper.py +28 -0
- sparknlp/training/conll.py +150 -0
- sparknlp/training/conllu.py +103 -0
- sparknlp/training/pos.py +103 -0
- sparknlp/training/pub_tator.py +76 -0
- sparknlp/training/spacy_to_annotation.py +57 -0
- sparknlp/training/tfgraphs.py +5 -0
- sparknlp/upload_to_hub.py +149 -0
- sparknlp/util.py +51 -5
- com/__init__.pyc +0 -0
- com/__pycache__/__init__.cpython-36.pyc +0 -0
- com/johnsnowlabs/__init__.pyc +0 -0
- com/johnsnowlabs/__pycache__/__init__.cpython-36.pyc +0 -0
- com/johnsnowlabs/nlp/__init__.pyc +0 -0
- com/johnsnowlabs/nlp/__pycache__/__init__.cpython-36.pyc +0 -0
- spark_nlp-2.6.3rc1.dist-info/METADATA +0 -36
- spark_nlp-2.6.3rc1.dist-info/RECORD +0 -48
- sparknlp/__init__.pyc +0 -0
- sparknlp/__pycache__/__init__.cpython-36.pyc +0 -0
- sparknlp/__pycache__/annotation.cpython-36.pyc +0 -0
- sparknlp/__pycache__/annotator.cpython-36.pyc +0 -0
- sparknlp/__pycache__/base.cpython-36.pyc +0 -0
- sparknlp/__pycache__/common.cpython-36.pyc +0 -0
- sparknlp/__pycache__/embeddings.cpython-36.pyc +0 -0
- sparknlp/__pycache__/functions.cpython-36.pyc +0 -0
- sparknlp/__pycache__/internal.cpython-36.pyc +0 -0
- sparknlp/__pycache__/pretrained.cpython-36.pyc +0 -0
- sparknlp/__pycache__/storage.cpython-36.pyc +0 -0
- sparknlp/__pycache__/training.cpython-36.pyc +0 -0
- sparknlp/__pycache__/util.cpython-36.pyc +0 -0
- sparknlp/annotation.pyc +0 -0
- sparknlp/annotator.py +0 -3006
- sparknlp/annotator.pyc +0 -0
- sparknlp/base.py +0 -347
- sparknlp/base.pyc +0 -0
- sparknlp/common.py +0 -193
- sparknlp/common.pyc +0 -0
- sparknlp/embeddings.py +0 -40
- sparknlp/embeddings.pyc +0 -0
- sparknlp/internal.py +0 -288
- sparknlp/internal.pyc +0 -0
- sparknlp/pretrained.py +0 -123
- sparknlp/pretrained.pyc +0 -0
- sparknlp/storage.py +0 -32
- sparknlp/storage.pyc +0 -0
- sparknlp/training.py +0 -62
- sparknlp/training.pyc +0 -0
- sparknlp/util.pyc +0 -0
- {spark_nlp-2.6.3rc1.dist-info → spark_nlp-6.2.1.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# Copyright 2017-2022 John Snow Labs
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
from pyspark import keyword_only
|
|
15
|
+
from pyspark.ml.param import TypeConverters, Params, Param
|
|
16
|
+
|
|
17
|
+
from sparknlp.common import AnnotatorType
|
|
18
|
+
from sparknlp.internal import AnnotatorTransformer
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class MultiDocumentAssembler(AnnotatorTransformer):
|
|
22
|
+
"""Prepares data into a format that is processable by Spark NLP.
|
|
23
|
+
|
|
24
|
+
This is the entry point for every Spark NLP pipeline. The
|
|
25
|
+
`MultiDocumentAssembler` can read either a ``String`` column or an
|
|
26
|
+
``Array[String]``. Additionally, :meth:`.setCleanupMode` can be used to
|
|
27
|
+
pre-process the text (Default: ``disabled``). For possible options please
|
|
28
|
+
refer the parameters section.
|
|
29
|
+
|
|
30
|
+
For more extended examples on document pre-processing see the
|
|
31
|
+
`Examples <https://github.com/JohnSnowLabs/spark-nlp/blob/master/examples/python/annotation/text/english/document-assembler/Loading_Multiple_Documents.ipynb>`__.
|
|
32
|
+
|
|
33
|
+
====================== ======================
|
|
34
|
+
Input Annotation types Output Annotation type
|
|
35
|
+
====================== ======================
|
|
36
|
+
``NONE`` ``DOCUMENT``
|
|
37
|
+
====================== ======================
|
|
38
|
+
|
|
39
|
+
Parameters
|
|
40
|
+
----------
|
|
41
|
+
inputCols: str or List[str]
|
|
42
|
+
Input column name.
|
|
43
|
+
outputCols: str or List[str]
|
|
44
|
+
Output column name.
|
|
45
|
+
idCol: str
|
|
46
|
+
Name of String type column for row id.
|
|
47
|
+
metadataCol: str
|
|
48
|
+
Name of Map type column with metadata information
|
|
49
|
+
cleanupMode: str
|
|
50
|
+
How to cleanup the document , by default disabled.
|
|
51
|
+
Possible values: ``disabled, inplace, inplace_full, shrink, shrink_full,
|
|
52
|
+
each, each_full, delete_full``
|
|
53
|
+
|
|
54
|
+
Examples
|
|
55
|
+
--------
|
|
56
|
+
>>> import sparknlp
|
|
57
|
+
>>> from sparknlp.base import *
|
|
58
|
+
>>> from pyspark.ml import Pipeline
|
|
59
|
+
>>> data = spark.createDataFrame([["Spark NLP is an open-source text processing library."], ["Spark NLP is a state-of-the-art Natural Language Processing library built on top of Apache Spark"]]).toDF("text", "text2")
|
|
60
|
+
>>> documentAssembler = MultiDocumentAssembler().setInputCols(["text", "text2"]).setOutputCols(["document1", "document2"])
|
|
61
|
+
>>> result = documentAssembler.transform(data)
|
|
62
|
+
>>> result.select("document1").show(truncate=False)
|
|
63
|
+
+----------------------------------------------------------------------------------------------+
|
|
64
|
+
|document1 |
|
|
65
|
+
+----------------------------------------------------------------------------------------------+
|
|
66
|
+
|[[document, 0, 51, Spark NLP is an open-source text processing library., [sentence -> 0], []]]|
|
|
67
|
+
+----------------------------------------------------------------------------------------------+
|
|
68
|
+
>>> result.select("document1").printSchema()
|
|
69
|
+
root
|
|
70
|
+
|-- document: array (nullable = True)
|
|
71
|
+
| |-- element: struct (containsNull = True)
|
|
72
|
+
| | |-- annotatorType: string (nullable = True)
|
|
73
|
+
| | |-- begin: integer (nullable = False)
|
|
74
|
+
| | |-- end: integer (nullable = False)
|
|
75
|
+
| | |-- result: string (nullable = True)
|
|
76
|
+
| | |-- metadata: map (nullable = True)
|
|
77
|
+
| | | |-- key: string
|
|
78
|
+
| | | |-- value: string (valueContainsNull = True)
|
|
79
|
+
| | |-- embeddings: array (nullable = True)
|
|
80
|
+
| | | |-- element: float (containsNull = False)
|
|
81
|
+
"""
|
|
82
|
+
|
|
83
|
+
outputAnnotatorType = AnnotatorType.DOCUMENT
|
|
84
|
+
|
|
85
|
+
inputCols = Param(Params._dummy(), "inputCols", "input annotations", typeConverter=TypeConverters.toListString)
|
|
86
|
+
outputCols = Param(Params._dummy(), "outputCols", "output finished annotation cols", typeConverter=TypeConverters.toListString)
|
|
87
|
+
idCol = Param(Params._dummy(), "idCol", "column for setting an id to such string in row", typeConverter=TypeConverters.toString)
|
|
88
|
+
metadataCol = Param(Params._dummy(), "metadataCol", "String to String map column to use as metadata", typeConverter=TypeConverters.toString)
|
|
89
|
+
cleanupMode = Param(Params._dummy(), "cleanupMode", "possible values: disabled, inplace, inplace_full, shrink, shrink_full, each, each_full, delete_full", typeConverter=TypeConverters.toString)
|
|
90
|
+
name = 'MultiDocumentAssembler'
|
|
91
|
+
|
|
92
|
+
@keyword_only
|
|
93
|
+
def __init__(self):
|
|
94
|
+
super(MultiDocumentAssembler, self).__init__(classname="com.johnsnowlabs.nlp.MultiDocumentAssembler")
|
|
95
|
+
self._setDefault(cleanupMode='disabled')
|
|
96
|
+
|
|
97
|
+
@keyword_only
|
|
98
|
+
def setParams(self):
|
|
99
|
+
kwargs = self._input_kwargs
|
|
100
|
+
return self._set(**kwargs)
|
|
101
|
+
|
|
102
|
+
def setInputCols(self, *value):
|
|
103
|
+
"""Sets column names of input annotations.
|
|
104
|
+
|
|
105
|
+
Parameters
|
|
106
|
+
----------
|
|
107
|
+
*value : List[str]
|
|
108
|
+
Input columns for the annotator
|
|
109
|
+
"""
|
|
110
|
+
if len(value) == 1 and type(value[0]) == list:
|
|
111
|
+
return self._set(inputCols=value[0])
|
|
112
|
+
else:
|
|
113
|
+
return self._set(inputCols=list(value))
|
|
114
|
+
|
|
115
|
+
def setOutputCols(self, *value):
|
|
116
|
+
"""Sets column names of output annotations.
|
|
117
|
+
|
|
118
|
+
Parameters
|
|
119
|
+
----------
|
|
120
|
+
*value : List[str]
|
|
121
|
+
List of output columns
|
|
122
|
+
"""
|
|
123
|
+
if len(value) == 1 and type(value[0]) == list:
|
|
124
|
+
return self._set(outputCols=value[0])
|
|
125
|
+
else:
|
|
126
|
+
return self._set(outputCols=list(value))
|
|
127
|
+
|
|
128
|
+
def setIdCol(self, value):
|
|
129
|
+
"""Sets name of string type column for row id.
|
|
130
|
+
|
|
131
|
+
Parameters
|
|
132
|
+
----------
|
|
133
|
+
value : str
|
|
134
|
+
Name of the Id Column
|
|
135
|
+
"""
|
|
136
|
+
return self._set(idCol=value)
|
|
137
|
+
|
|
138
|
+
def setMetadataCol(self, value):
|
|
139
|
+
"""Sets name for Map type column with metadata information.
|
|
140
|
+
|
|
141
|
+
Parameters
|
|
142
|
+
----------
|
|
143
|
+
value : str
|
|
144
|
+
Name of the metadata column
|
|
145
|
+
"""
|
|
146
|
+
return self._set(metadataCol=value)
|
|
147
|
+
|
|
148
|
+
def setCleanupMode(self, value):
|
|
149
|
+
"""Sets how to cleanup the document, by default disabled.
|
|
150
|
+
Possible values: ``disabled, inplace, inplace_full, shrink, shrink_full,
|
|
151
|
+
each, each_full, delete_full``
|
|
152
|
+
|
|
153
|
+
Parameters
|
|
154
|
+
----------
|
|
155
|
+
value : str
|
|
156
|
+
Cleanup mode
|
|
157
|
+
"""
|
|
158
|
+
if value.strip().lower() not in ['disabled', 'inplace', 'inplace_full', 'shrink', 'shrink_full', 'each', 'each_full', 'delete_full']:
|
|
159
|
+
raise Exception("Cleanup mode possible values: disabled, inplace, inplace_full, shrink, shrink_full, each, each_full, delete_full")
|
|
160
|
+
return self._set(cleanupMode=value)
|
|
161
|
+
|
|
162
|
+
def getOutputCols(self):
|
|
163
|
+
"""Gets output columns name of annotations."""
|
|
164
|
+
return self.getOrDefault(self.outputCols)
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
# Copyright 2017-2024 John Snow Labs
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
"""Contains classes for the PromptAssembler."""
|
|
15
|
+
|
|
16
|
+
from pyspark import keyword_only
|
|
17
|
+
from pyspark.ml.param import TypeConverters, Params, Param
|
|
18
|
+
|
|
19
|
+
from sparknlp.common import AnnotatorType
|
|
20
|
+
from sparknlp.internal import AnnotatorTransformer
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class PromptAssembler(AnnotatorTransformer):
|
|
24
|
+
"""Assembles a sequence of messages into a single string using a template. These strings can then
|
|
25
|
+
be used as prompts for large language models.
|
|
26
|
+
|
|
27
|
+
This annotator expects an array of two-tuples as the type of the input column (one array of
|
|
28
|
+
tuples per row). The first element of the tuples should be the role and the second element is
|
|
29
|
+
the text of the message. Possible roles are "system", "user" and "assistant".
|
|
30
|
+
|
|
31
|
+
An assistant header can be added to the end of the generated string by using
|
|
32
|
+
``setAddAssistant(True)``.
|
|
33
|
+
|
|
34
|
+
At the moment, this annotator uses llama.cpp as a backend to parse and apply the templates.
|
|
35
|
+
llama.cpp uses basic pattern matching to determine the type of the template, then applies a
|
|
36
|
+
basic version of the template to the messages. This means that more advanced templates are not
|
|
37
|
+
supported.
|
|
38
|
+
|
|
39
|
+
For an extended example see the
|
|
40
|
+
`example notebook <https://github.com/JohnSnowLabs/spark-nlp/blob/master/examples/python/llama.cpp/PromptAssember_with_AutoGGUFModel.ipynb>`__.
|
|
41
|
+
|
|
42
|
+
====================== ======================
|
|
43
|
+
Input Annotation types Output Annotation type
|
|
44
|
+
====================== ======================
|
|
45
|
+
``NONE`` ``DOCUMENT``
|
|
46
|
+
====================== ======================
|
|
47
|
+
|
|
48
|
+
Parameters
|
|
49
|
+
----------
|
|
50
|
+
inputCol
|
|
51
|
+
Input column name
|
|
52
|
+
outputCol
|
|
53
|
+
Output column name
|
|
54
|
+
chatTemplate
|
|
55
|
+
Template used for the chat
|
|
56
|
+
addAssistant
|
|
57
|
+
Whether to add an assistant header to the end of the generated string
|
|
58
|
+
|
|
59
|
+
Examples
|
|
60
|
+
--------
|
|
61
|
+
>>> from sparknlp.base import *
|
|
62
|
+
>>> messages = [
|
|
63
|
+
... [
|
|
64
|
+
... ("system", "You are a helpful assistant."),
|
|
65
|
+
... ("assistant", "Hello there, how can I help you?"),
|
|
66
|
+
... ("user", "I need help with organizing my room."),
|
|
67
|
+
... ]
|
|
68
|
+
... ]
|
|
69
|
+
>>> df = spark.createDataFrame([messages]).toDF("messages")
|
|
70
|
+
>>> template = (
|
|
71
|
+
... "{{- bos_token }} {%- if custom_tools is defined %} {%- set tools = custom_tools %} {%- "
|
|
72
|
+
... "endif %} {%- if not tools_in_user_message is defined %} {%- set tools_in_user_message = true %} {%- "
|
|
73
|
+
... 'endif %} {%- if not date_string is defined %} {%- set date_string = "26 Jul 2024" %} {%- endif %} '
|
|
74
|
+
... "{%- if not tools is defined %} {%- set tools = none %} {%- endif %} {#- This block extracts the "
|
|
75
|
+
... "system message, so we can slot it into the right place. #} {%- if messages[0]['role'] == 'system' %}"
|
|
76
|
+
... " {%- set system_message = messages[0]['content']|trim %} {%- set messages = messages[1:] %} {%- else"
|
|
77
|
+
... ' %} {%- set system_message = "" %} {%- endif %} {#- System message + builtin tools #} {{- '
|
|
78
|
+
... '"<|start_header_id|>system<|end_header_id|>\\n\\n" }} {%- if builtin_tools is defined or tools is '
|
|
79
|
+
... 'not none %} {{- "Environment: ipython\\n" }} {%- endif %} {%- if builtin_tools is defined %} {{- '
|
|
80
|
+
... '"Tools: " + builtin_tools | reject(\\'equalto\', \\'code_interpreter\\') | join(", ") + "\\n\\n"}} '
|
|
81
|
+
... '{%- endif %} {{- "Cutting Knowledge Date: December 2023\\n" }} {{- "Today Date: " + date_string '
|
|
82
|
+
... '+ "\\n\\n" }} {%- if tools is not none and not tools_in_user_message %} {{- "You have access to '
|
|
83
|
+
... 'the following functions. To call a function, please respond with JSON for a function call." }} {{- '
|
|
84
|
+
... '\\'Respond in the format {"name": function name, "parameters": dictionary of argument name and its'
|
|
85
|
+
... ' value}.\\' }} {{- "Do not use variables.\\n\\n" }} {%- for t in tools %} {{- t | tojson(indent=4) '
|
|
86
|
+
... '}} {{- "\\n\\n" }} {%- endfor %} {%- endif %} {{- system_message }} {{- "<|eot_id|>" }} {#- '
|
|
87
|
+
... "Custom tools are passed in a user message with some extra guidance #} {%- if tools_in_user_message "
|
|
88
|
+
... "and not tools is none %} {#- Extract the first user message so we can plug it in here #} {%- if "
|
|
89
|
+
... "messages | length != 0 %} {%- set first_user_message = messages[0]['content']|trim %} {%- set "
|
|
90
|
+
... 'messages = messages[1:] %} {%- else %} {{- raise_exception("Cannot put tools in the first user '
|
|
91
|
+
... "message when there's no first user message!\\") }} {%- endif %} {{- "
|
|
92
|
+
... "'<|start_header_id|>user<|end_header_id|>\\n\\n' -}} {{- \\"Given the following functions, please "
|
|
93
|
+
... 'respond with a JSON for a function call " }} {{- "with its proper arguments that best answers the '
|
|
94
|
+
... 'given prompt.\\n\\n" }} {{- \\'Respond in the format {"name": function name, "parameters": '
|
|
95
|
+
... 'dictionary of argument name and its value}.\\' }} {{- "Do not use variables.\\n\\n" }} {%- for t in '
|
|
96
|
+
... 'tools %} {{- t | tojson(indent=4) }} {{- "\\n\\n" }} {%- endfor %} {{- first_user_message + '
|
|
97
|
+
... "\\"<|eot_id|>\\"}} {%- endif %} {%- for message in messages %} {%- if not (message.role == 'ipython' "
|
|
98
|
+
... "or message.role == 'tool' or 'tool_calls' in message) %} {{- '<|start_header_id|>' + message['role']"
|
|
99
|
+
... " + '<|end_header_id|>\\n\\n'+ message['content'] | trim + '<|eot_id|>' }} {%- elif 'tool_calls' in "
|
|
100
|
+
... 'message %} {%- if not message.tool_calls|length == 1 %} {{- raise_exception("This model only '
|
|
101
|
+
... 'supports single tool-calls at once!") }} {%- endif %} {%- set tool_call = message.tool_calls[0]'
|
|
102
|
+
... ".function %} {%- if builtin_tools is defined and tool_call.name in builtin_tools %} {{- "
|
|
103
|
+
... "'<|start_header_id|>assistant<|end_header_id|>\\n\\n' -}} {{- \\"<|python_tag|>\\" + tool_call.name + "
|
|
104
|
+
... '".call(" }} {%- for arg_name, arg_val in tool_call.arguments | items %} {{- arg_name + \\'="\\' + '
|
|
105
|
+
... 'arg_val + \\'"\\' }} {%- if not loop.last %} {{- ", " }} {%- endif %} {%- endfor %} {{- ")" }} {%- '
|
|
106
|
+
... "else %} {{- '<|start_header_id|>assistant<|end_header_id|>\\n\\n' -}} {{- '{\\"name\": \\"' + "
|
|
107
|
+
... 'tool_call.name + \\'", \\' }} {{- \\'"parameters": \\' }} {{- tool_call.arguments | tojson }} {{- "}" '
|
|
108
|
+
... "}} {%- endif %} {%- if builtin_tools is defined %} {#- This means we're in ipython mode #} {{- "
|
|
109
|
+
... '"<|eom_id|>" }} {%- else %} {{- "<|eot_id|>" }} {%- endif %} {%- elif message.role == "tool" '
|
|
110
|
+
... 'or message.role == "ipython" %} {{- "<|start_header_id|>ipython<|end_header_id|>\\n\\n" }} {%- '
|
|
111
|
+
... "if message.content is mapping or message.content is iterable %} {{- message.content | tojson }} {%- "
|
|
112
|
+
... 'else %} {{- message.content }} {%- endif %} {{- "<|eot_id|>" }} {%- endif %} {%- endfor %} {%- if '
|
|
113
|
+
... "add_generation_prompt %} {{- '<|start_header_id|>assistant<|end_header_id|>\\n\\n' }} {%- endif %} "
|
|
114
|
+
... )
|
|
115
|
+
>>> prompt_assembler = (
|
|
116
|
+
... PromptAssembler()
|
|
117
|
+
... .setInputCol("messages")
|
|
118
|
+
... .setOutputCol("prompt")
|
|
119
|
+
... .setChatTemplate(template)
|
|
120
|
+
... )
|
|
121
|
+
>>> prompt_assembler.transform(df).select("prompt.result").show(truncate=False)
|
|
122
|
+
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
123
|
+
|result |
|
|
124
|
+
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
125
|
+
|[<|start_header_id|>system<|end_header_id|>\\n\\nYou are a helpful assistant.<|eot_id|><|start_header_id|>assistant<|end_header_id|>\\n\\nHello there, how can I help you?<|eot_id|><|start_header_id|>user<|end_header_id|>\\n\\nI need help with organizing my room.<|eot_id|><|start_header_id|>assistant<|end_header_id|>\\n\\n]|
|
|
126
|
+
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
127
|
+
"""
|
|
128
|
+
|
|
129
|
+
outputAnnotatorType = AnnotatorType.DOCUMENT
|
|
130
|
+
|
|
131
|
+
inputCol = Param(
|
|
132
|
+
Params._dummy(),
|
|
133
|
+
"inputCol",
|
|
134
|
+
"input column name",
|
|
135
|
+
typeConverter=TypeConverters.toString,
|
|
136
|
+
)
|
|
137
|
+
outputCol = Param(
|
|
138
|
+
Params._dummy(),
|
|
139
|
+
"outputCol",
|
|
140
|
+
"output column name",
|
|
141
|
+
typeConverter=TypeConverters.toString,
|
|
142
|
+
)
|
|
143
|
+
chatTemplate = Param(
|
|
144
|
+
Params._dummy(),
|
|
145
|
+
"chatTemplate",
|
|
146
|
+
"Template used for the chat",
|
|
147
|
+
typeConverter=TypeConverters.toString,
|
|
148
|
+
)
|
|
149
|
+
addAssistant = Param(
|
|
150
|
+
Params._dummy(),
|
|
151
|
+
"addAssistant",
|
|
152
|
+
"Whether to add an assistant header to the end of the generated string",
|
|
153
|
+
typeConverter=TypeConverters.toBoolean,
|
|
154
|
+
)
|
|
155
|
+
name = "PromptAssembler"
|
|
156
|
+
|
|
157
|
+
@keyword_only
|
|
158
|
+
def __init__(self):
|
|
159
|
+
super(PromptAssembler, self).__init__(
|
|
160
|
+
classname="com.johnsnowlabs.nlp.PromptAssembler"
|
|
161
|
+
)
|
|
162
|
+
self._setDefault(outputCol="prompt", addAssistant=True)
|
|
163
|
+
|
|
164
|
+
@keyword_only
|
|
165
|
+
def setParams(self):
|
|
166
|
+
kwargs = self._input_kwargs
|
|
167
|
+
return self._set(**kwargs)
|
|
168
|
+
|
|
169
|
+
def setInputCol(self, value):
|
|
170
|
+
"""Sets input column name.
|
|
171
|
+
|
|
172
|
+
Parameters
|
|
173
|
+
----------
|
|
174
|
+
value : str
|
|
175
|
+
Name of the input column
|
|
176
|
+
"""
|
|
177
|
+
return self._set(inputCol=value)
|
|
178
|
+
|
|
179
|
+
def setOutputCol(self, value):
|
|
180
|
+
"""Sets output column name.
|
|
181
|
+
|
|
182
|
+
Parameters
|
|
183
|
+
----------
|
|
184
|
+
value : str
|
|
185
|
+
Name of the Output Column
|
|
186
|
+
"""
|
|
187
|
+
return self._set(outputCol=value)
|
|
188
|
+
|
|
189
|
+
def setChatTemplate(self, value):
|
|
190
|
+
"""Sets the chat template.
|
|
191
|
+
|
|
192
|
+
Parameters
|
|
193
|
+
----------
|
|
194
|
+
value : str
|
|
195
|
+
Template used for the chat
|
|
196
|
+
"""
|
|
197
|
+
return self._set(chatTemplate=value)
|
|
198
|
+
|
|
199
|
+
def setAddAssistant(self, value):
|
|
200
|
+
"""Sets whether to add an assistant header to the end of the generated string.
|
|
201
|
+
|
|
202
|
+
Parameters
|
|
203
|
+
----------
|
|
204
|
+
value : bool
|
|
205
|
+
Whether to add an assistant header to the end of the generated string
|
|
206
|
+
"""
|
|
207
|
+
return self._set(addAssistant=value)
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Copyright 2017-2022 John Snow Labs
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
"""Contains classes for the RecursivePipeline."""
|
|
15
|
+
|
|
16
|
+
from pyspark import keyword_only
|
|
17
|
+
from pyspark.ml import PipelineModel, Estimator, Pipeline, Transformer
|
|
18
|
+
from pyspark.ml.wrapper import JavaEstimator
|
|
19
|
+
|
|
20
|
+
from sparknlp.common import AnnotatorProperties
|
|
21
|
+
from sparknlp.internal import RecursiveEstimator
|
|
22
|
+
from sparknlp.base import HasRecursiveTransform
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
class RecursivePipeline(Pipeline, JavaEstimator):
|
|
26
|
+
"""Recursive pipelines are Spark NLP specific pipelines that allow a Spark
|
|
27
|
+
ML Pipeline to know about itself on every Pipeline Stage task.
|
|
28
|
+
|
|
29
|
+
This allows annotators to utilize this same pipeline against external
|
|
30
|
+
resources to process them in the same way the user decides.
|
|
31
|
+
|
|
32
|
+
Only some of the annotators take advantage of this. RecursivePipeline
|
|
33
|
+
behaves exactly the same as normal Spark ML pipelines, so they can be used
|
|
34
|
+
with the same intention.
|
|
35
|
+
|
|
36
|
+
Examples
|
|
37
|
+
--------
|
|
38
|
+
>>> from sparknlp.annotator import *
|
|
39
|
+
>>> from sparknlp.base import *
|
|
40
|
+
>>> recursivePipeline = RecursivePipeline(stages=[
|
|
41
|
+
... documentAssembler,
|
|
42
|
+
... sentenceDetector,
|
|
43
|
+
... tokenizer,
|
|
44
|
+
... lemmatizer,
|
|
45
|
+
... finisher
|
|
46
|
+
... ])
|
|
47
|
+
"""
|
|
48
|
+
@keyword_only
|
|
49
|
+
def __init__(self, *args, **kwargs):
|
|
50
|
+
super(RecursivePipeline, self).__init__(*args, **kwargs)
|
|
51
|
+
self._java_obj = self._new_java_obj("com.johnsnowlabs.nlp.RecursivePipeline", self.uid)
|
|
52
|
+
kwargs = self._input_kwargs
|
|
53
|
+
self.setParams(**kwargs)
|
|
54
|
+
|
|
55
|
+
def _fit(self, dataset):
|
|
56
|
+
stages = self.getStages()
|
|
57
|
+
for stage in stages:
|
|
58
|
+
if not (isinstance(stage, Estimator) or isinstance(stage, Transformer)):
|
|
59
|
+
raise TypeError(
|
|
60
|
+
"Cannot recognize a pipeline stage of type %s." % type(stage))
|
|
61
|
+
indexOfLastEstimator = -1
|
|
62
|
+
for i, stage in enumerate(stages):
|
|
63
|
+
if isinstance(stage, Estimator):
|
|
64
|
+
indexOfLastEstimator = i
|
|
65
|
+
transformers = []
|
|
66
|
+
for i, stage in enumerate(stages):
|
|
67
|
+
if i <= indexOfLastEstimator:
|
|
68
|
+
if isinstance(stage, Transformer):
|
|
69
|
+
transformers.append(stage)
|
|
70
|
+
dataset = stage.transform(dataset)
|
|
71
|
+
elif isinstance(stage, RecursiveEstimator):
|
|
72
|
+
model = stage.fit(dataset, pipeline=PipelineModel(transformers))
|
|
73
|
+
transformers.append(model)
|
|
74
|
+
if i < indexOfLastEstimator:
|
|
75
|
+
dataset = model.transform(dataset)
|
|
76
|
+
else:
|
|
77
|
+
model = stage.fit(dataset)
|
|
78
|
+
transformers.append(model)
|
|
79
|
+
if i < indexOfLastEstimator:
|
|
80
|
+
dataset = model.transform(dataset)
|
|
81
|
+
else:
|
|
82
|
+
transformers.append(stage)
|
|
83
|
+
return PipelineModel(transformers)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
class RecursivePipelineModel(PipelineModel):
|
|
87
|
+
"""Fitted RecursivePipeline.
|
|
88
|
+
|
|
89
|
+
Behaves the same as a Spark PipelineModel does. Not intended to be
|
|
90
|
+
initialized by itself. To create a RecursivePipelineModel please fit data to
|
|
91
|
+
a :class:`.RecursivePipeline`.
|
|
92
|
+
"""
|
|
93
|
+
def __init__(self, pipeline_model):
|
|
94
|
+
super(PipelineModel, self).__init__()
|
|
95
|
+
self.stages = pipeline_model.stages
|
|
96
|
+
|
|
97
|
+
def _transform(self, dataset):
|
|
98
|
+
for t in self.stages:
|
|
99
|
+
if isinstance(t, HasRecursiveTransform):
|
|
100
|
+
# drops current stage from the recursive pipeline within
|
|
101
|
+
dataset = t.transform_recursive(dataset, PipelineModel(self.stages[:-1]))
|
|
102
|
+
elif isinstance(t, AnnotatorProperties) and t.getLazyAnnotator():
|
|
103
|
+
pass
|
|
104
|
+
else:
|
|
105
|
+
dataset = t.transform(dataset)
|
|
106
|
+
return dataset
|
|
107
|
+
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
# Copyright 2017-2022 John Snow Labs
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
"""Contains classes for the TableAssembler."""
|
|
15
|
+
from sparknlp.common import *
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class TableAssembler(AnnotatorModel):
|
|
19
|
+
"""This transformer parses text into tabular representation. The input consists of DOCUMENT annotations and the
|
|
20
|
+
output are TABLE annotations. The source format can be either JSON or CSV. The CSV format support alternative
|
|
21
|
+
delimiters (e.g. tab), as well as escaping delimiters by surrounding cell values with double quotes.
|
|
22
|
+
|
|
23
|
+
The transformer stores tabular data internally as JSON. The default input format is also JSON.
|
|
24
|
+
|
|
25
|
+
====================== ======================
|
|
26
|
+
Input Annotation types Output Annotation type
|
|
27
|
+
====================== ======================
|
|
28
|
+
``DOCUMENT`` ``TABLE``
|
|
29
|
+
====================== ======================
|
|
30
|
+
|
|
31
|
+
Parameters
|
|
32
|
+
----------
|
|
33
|
+
inputFormat
|
|
34
|
+
The format of the source representation of the table ('json' or 'csv')
|
|
35
|
+
|
|
36
|
+
csvDelimiter
|
|
37
|
+
The delimiter used for parsing CSV files (defailt is comma)
|
|
38
|
+
|
|
39
|
+
escapeCsvDelimiter
|
|
40
|
+
Whether to escape Csv delimiter by surrounding values with double quotes
|
|
41
|
+
|
|
42
|
+
Examples
|
|
43
|
+
--------
|
|
44
|
+
>>> import sparknlp
|
|
45
|
+
>>> from sparknlp.base import *
|
|
46
|
+
>>> from sparknlp.annotator import *
|
|
47
|
+
>>> from pyspark.ml import Pipeline
|
|
48
|
+
>>>
|
|
49
|
+
>>> document_assembler = DocumentAssembler() \\
|
|
50
|
+
... .setInputCol("table_csv") \\
|
|
51
|
+
... .setOutputCol("document_table")
|
|
52
|
+
>>> table_assembler = TableAssembler()\\
|
|
53
|
+
>>> .setInputFormat("csv")\\
|
|
54
|
+
>>> .setInputCols(["document_table"])\\
|
|
55
|
+
>>> .setOutputCol("table")
|
|
56
|
+
>>>
|
|
57
|
+
>>> csv_data = "\\n".join([
|
|
58
|
+
>>> "name, money, age",
|
|
59
|
+
>>> "Donald Trump, \"100,000,000\", 75",
|
|
60
|
+
>>> "Elon Musk, \"20,000,000,000,000\", 55"])
|
|
61
|
+
>>> data = spark.createDataFrame([[csv_data]]) \\
|
|
62
|
+
... .toDF("table_csv")
|
|
63
|
+
>>> pipeline = Pipeline().setStages([
|
|
64
|
+
... document_assembler,
|
|
65
|
+
... table_assembler
|
|
66
|
+
... ]).fit(data)
|
|
67
|
+
>>> result = pipeline.transform(data)
|
|
68
|
+
>>> result.select("table").show(truncate=False)
|
|
69
|
+
+-----------------------------------------------+
|
|
70
|
+
|table |
|
|
71
|
+
+-----------------------------------------------+
|
|
72
|
+
|[[table, 0, 118, { |
|
|
73
|
+
| "header":["name","money","age"], |
|
|
74
|
+
| "rows":[ |
|
|
75
|
+
| ["Donald Trump","100,000,000","75"], |
|
|
76
|
+
| ["Elon Musk","20,000,000,000,000","55"]] |
|
|
77
|
+
| }, |
|
|
78
|
+
| [sentence -> 0, input_format -> csv], []]] |
|
|
79
|
+
+-----------------------------------------------+
|
|
80
|
+
"""
|
|
81
|
+
name = "TableAssembler"
|
|
82
|
+
|
|
83
|
+
inputAnnotatorTypes = [AnnotatorType.DOCUMENT]
|
|
84
|
+
|
|
85
|
+
outputAnnotatorType = AnnotatorType.TABLE
|
|
86
|
+
|
|
87
|
+
inputFormat = Param(
|
|
88
|
+
Params._dummy(),
|
|
89
|
+
"inputFormat",
|
|
90
|
+
"Input format ('json' or 'csv')",
|
|
91
|
+
typeConverter=TypeConverters.toString)
|
|
92
|
+
|
|
93
|
+
csvDelimiter = Param(
|
|
94
|
+
Params._dummy(),
|
|
95
|
+
"csvDelimiter",
|
|
96
|
+
"CSV delimiter",
|
|
97
|
+
typeConverter=TypeConverters.toString)
|
|
98
|
+
|
|
99
|
+
escapeCsvDelimiter = Param(
|
|
100
|
+
Params._dummy(),
|
|
101
|
+
"escapeCsvDelimiter",
|
|
102
|
+
"Escape Csv delimiter by surrounding values with double quotes",
|
|
103
|
+
typeConverter=TypeConverters.toBoolean)
|
|
104
|
+
|
|
105
|
+
def setInputFormat(self, value):
|
|
106
|
+
"""Sets the table input format. The following formats are currently supported: json, csv.
|
|
107
|
+
|
|
108
|
+
Parameters
|
|
109
|
+
----------
|
|
110
|
+
value : str
|
|
111
|
+
Table input format
|
|
112
|
+
"""
|
|
113
|
+
return self._set(inputFormat=value)
|
|
114
|
+
|
|
115
|
+
def setCsvDelimiter(self, value):
|
|
116
|
+
"""Sets the CSV delimiter.
|
|
117
|
+
|
|
118
|
+
Parameters
|
|
119
|
+
----------
|
|
120
|
+
value : str
|
|
121
|
+
CSV delimiter
|
|
122
|
+
"""
|
|
123
|
+
return self._set(csvDelimiter=value)
|
|
124
|
+
|
|
125
|
+
def setEscapeCsvDelimiter(self, value):
|
|
126
|
+
"""Escape Csv delimiter by surrounding values with double quotes
|
|
127
|
+
|
|
128
|
+
Parameters
|
|
129
|
+
----------
|
|
130
|
+
value : bool
|
|
131
|
+
True of Csv delimiter is escaped by surrounding values with double quotes
|
|
132
|
+
"""
|
|
133
|
+
return self._set(escapeCsvDelimiter=value)
|
|
134
|
+
|
|
135
|
+
@keyword_only
|
|
136
|
+
def __init__(self, classname="com.johnsnowlabs.nlp.TableAssembler", java_model=None):
|
|
137
|
+
super(TableAssembler, self).__init__(
|
|
138
|
+
classname=classname,
|
|
139
|
+
java_model=java_model
|
|
140
|
+
)
|
|
141
|
+
self._setDefault(
|
|
142
|
+
inputFormat="json",
|
|
143
|
+
csvDelimiter=",",
|
|
144
|
+
escapeCsvDelimiter=True
|
|
145
|
+
)
|