
<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

    <title>sparknlp.base.GraphFinisher &#8212; Spark NLP 3.4.2 documentation</title>
    
    <link href="../../static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link href="../../static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
  
    
    <link rel="stylesheet"
      href="../../static/vendor/fontawesome/5.13.0/css/all.min.css">
    <link rel="preload" as="font" type="font/woff2" crossorigin
      href="../../static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
    <link rel="preload" as="font" type="font/woff2" crossorigin
      href="../../static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
  
    
      
  
    
    <link rel="stylesheet" type="text/css" href="../../static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../../static/styles/pydata-sphinx-theme.css" />
    <link rel="stylesheet" type="text/css" href="../../static/css/custom.css" />
    
    <link rel="preload" as="script" href="../../static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf">
  
    <script data-url_root="../../" id="documentation_options" src="../../static/documentation_options.js"></script>
    <script src="../../static/jquery.js"></script>
    <script src="../../static/underscore.js"></script>
    <script src="../../static/doctools.js"></script>
    <script src="../../static/toggleprompt.js"></script>
    <link rel="shortcut icon" href="../../static/fav.ico"/>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="sparknlp.base.HasRecursiveFit" href="sparknlp.base.HasRecursiveFit.html" />
    <link rel="prev" title="sparknlp.base.Finisher" href="sparknlp.base.Finisher.html" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <meta name="docsearch:language" content="None">
    

    <!-- Google Analytics -->
    
  </head>
  <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
    
    <div class="container-fluid" id="banner"></div>

    
    <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="container-xl">

  <div id="navbar-start">
    
    

<a class="navbar-brand" href="../../index.html">
  <img src="../../static/logo.png" class="logo" alt="logo">
</a>


    
  </div>

  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>

  
  <div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
    <div id="navbar-center" class="mr-auto">
      
      <div class="navbar-center-item">
        <ul id="navbar-main-elements" class="navbar-nav">
    <li class="toctree-l1 nav-item">
 <a class="reference internal nav-link" href="../../getting_started/index.html">
  Getting Started
 </a>
</li>

<li class="toctree-l1 nav-item">
 <a class="reference internal nav-link" href="../../user_guide/index.html">
  User Guide
 </a>
</li>

<li class="toctree-l1 nav-item">
 <a class="reference internal nav-link" href="../../third_party/index.html">
  Third Party Projects
 </a>
</li>

<li class="toctree-l1 current active nav-item">
 <a class="reference internal nav-link" href="../index.html">
  API Reference
 </a>
</li>

    
</ul>
      </div>
      
    </div>

    <div id="navbar-end">
      
      <div class="navbar-end-item">
        <ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
      </ul>
      </div>
      
    </div>
  </div>
</div>
    </nav>
    

    <div class="container-xl">
      <div class="row">
          
            
            <!-- Only show if we have sidebars configured, else just a small margin  -->
            <div class="col-12 col-md-3 bd-sidebar">
              <div class="sidebar-start-items"><form class="bd-search d-flex align-items-center" action="../../search.html" method="get">
  <i class="icon fas fa-search"></i>
  <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
  <div class="bd-toc-item active">
    <ul class="current nav bd-sidenav">
 <li class="toctree-l1 has-children">
  <a class="reference internal" href="sparknlp.annotator.html">
   sparknlp.annotator
  </a>
  <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/>
  <label for="toctree-checkbox-1">
   <i class="fas fa-chevron-down">
   </i>
  </label>
  <ul>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.AlbertEmbeddings.html">
     sparknlp.annotator.AlbertEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.AlbertForSequenceClassification.html">
     sparknlp.annotator.AlbertForSequenceClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.AlbertForTokenClassification.html">
     sparknlp.annotator.AlbertForTokenClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.BertEmbeddings.html">
     sparknlp.annotator.BertEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.BertForSequenceClassification.html">
     sparknlp.annotator.BertForSequenceClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.BertForTokenClassification.html">
     sparknlp.annotator.BertForTokenClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.BertSentenceEmbeddings.html">
     sparknlp.annotator.BertSentenceEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.BigTextMatcher.html">
     sparknlp.annotator.BigTextMatcher
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.BigTextMatcherModel.html">
     sparknlp.annotator.BigTextMatcherModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ChunkEmbeddings.html">
     sparknlp.annotator.ChunkEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ChunkTokenizer.html">
     sparknlp.annotator.ChunkTokenizer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ChunkTokenizerModel.html">
     sparknlp.annotator.ChunkTokenizerModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Chunker.html">
     sparknlp.annotator.Chunker
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ClassifierDLApproach.html">
     sparknlp.annotator.ClassifierDLApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ClassifierDLModel.html">
     sparknlp.annotator.ClassifierDLModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ContextSpellCheckerApproach.html">
     sparknlp.annotator.ContextSpellCheckerApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ContextSpellCheckerModel.html">
     sparknlp.annotator.ContextSpellCheckerModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DateMatcher.html">
     sparknlp.annotator.DateMatcher
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DateMatcherUtils.html">
     sparknlp.annotator.DateMatcherUtils
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DeBertaEmbeddings.html">
     sparknlp.annotator.DeBertaEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DependencyParserApproach.html">
     sparknlp.annotator.DependencyParserApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DependencyParserModel.html">
     sparknlp.annotator.DependencyParserModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DistilBertEmbeddings.html">
     sparknlp.annotator.DistilBertEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DistilBertForSequenceClassification.html">
     sparknlp.annotator.DistilBertForSequenceClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DistilBertForTokenClassification.html">
     sparknlp.annotator.DistilBertForTokenClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Doc2VecApproach.html">
     sparknlp.annotator.Doc2VecApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Doc2VecModel.html">
     sparknlp.annotator.Doc2VecModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.DocumentNormalizer.html">
     sparknlp.annotator.DocumentNormalizer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ElmoEmbeddings.html">
     sparknlp.annotator.ElmoEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.EntityRulerApproach.html">
     sparknlp.annotator.EntityRulerApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.EntityRulerModel.html">
     sparknlp.annotator.EntityRulerModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.GPT2Transformer.html">
     sparknlp.annotator.GPT2Transformer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.GraphExtraction.html">
     sparknlp.annotator.GraphExtraction
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.LanguageDetectorDL.html">
     sparknlp.annotator.LanguageDetectorDL
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Lemmatizer.html">
     sparknlp.annotator.Lemmatizer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.LemmatizerModel.html">
     sparknlp.annotator.LemmatizerModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.LongformerEmbeddings.html">
     sparknlp.annotator.LongformerEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.LongformerForSequenceClassification.html">
     sparknlp.annotator.LongformerForSequenceClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.LongformerForTokenClassification.html">
     sparknlp.annotator.LongformerForTokenClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.MarianTransformer.html">
     sparknlp.annotator.MarianTransformer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.MultiClassifierDLApproach.html">
     sparknlp.annotator.MultiClassifierDLApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.MultiClassifierDLModel.html">
     sparknlp.annotator.MultiClassifierDLModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.MultiDateMatcher.html">
     sparknlp.annotator.MultiDateMatcher
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NGramGenerator.html">
     sparknlp.annotator.NGramGenerator
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NerApproach.html">
     sparknlp.annotator.NerApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NerConverter.html">
     sparknlp.annotator.NerConverter
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NerCrfApproach.html">
     sparknlp.annotator.NerCrfApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NerCrfModel.html">
     sparknlp.annotator.NerCrfModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NerDLApproach.html">
     sparknlp.annotator.NerDLApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NerDLModel.html">
     sparknlp.annotator.NerDLModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NerOverwriter.html">
     sparknlp.annotator.NerOverwriter
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Normalizer.html">
     sparknlp.annotator.Normalizer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NormalizerModel.html">
     sparknlp.annotator.NormalizerModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NorvigSweetingApproach.html">
     sparknlp.annotator.NorvigSweetingApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.NorvigSweetingModel.html">
     sparknlp.annotator.NorvigSweetingModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.PerceptronApproach.html">
     sparknlp.annotator.PerceptronApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.PerceptronModel.html">
     sparknlp.annotator.PerceptronModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RecursiveTokenizer.html">
     sparknlp.annotator.RecursiveTokenizer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RecursiveTokenizerModel.html">
     sparknlp.annotator.RecursiveTokenizerModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RegexMatcher.html">
     sparknlp.annotator.RegexMatcher
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RegexMatcherModel.html">
     sparknlp.annotator.RegexMatcherModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RegexTokenizer.html">
     sparknlp.annotator.RegexTokenizer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RoBertaEmbeddings.html">
     sparknlp.annotator.RoBertaEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RoBertaForSequenceClassification.html">
     sparknlp.annotator.RoBertaForSequenceClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RoBertaForTokenClassification.html">
     sparknlp.annotator.RoBertaForTokenClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.RoBertaSentenceEmbeddings.html">
     sparknlp.annotator.RoBertaSentenceEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentenceDetector.html">
     sparknlp.annotator.SentenceDetector
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentenceDetectorDLApproach.html">
     sparknlp.annotator.SentenceDetectorDLApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentenceDetectorDLModel.html">
     sparknlp.annotator.SentenceDetectorDLModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentenceDetectorParams.html">
     sparknlp.annotator.SentenceDetectorParams
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentenceEmbeddings.html">
     sparknlp.annotator.SentenceEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentimentDLApproach.html">
     sparknlp.annotator.SentimentDLApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentimentDLModel.html">
     sparknlp.annotator.SentimentDLModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentimentDetector.html">
     sparknlp.annotator.SentimentDetector
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SentimentDetectorModel.html">
     sparknlp.annotator.SentimentDetectorModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Stemmer.html">
     sparknlp.annotator.Stemmer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.StopWordsCleaner.html">
     sparknlp.annotator.StopWordsCleaner
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SymmetricDeleteApproach.html">
     sparknlp.annotator.SymmetricDeleteApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.SymmetricDeleteModel.html">
     sparknlp.annotator.SymmetricDeleteModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.T5Transformer.html">
     sparknlp.annotator.T5Transformer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.TextMatcher.html">
     sparknlp.annotator.TextMatcher
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.TextMatcherModel.html">
     sparknlp.annotator.TextMatcherModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Token2Chunk.html">
     sparknlp.annotator.Token2Chunk
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Tokenizer.html">
     sparknlp.annotator.Tokenizer
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.TokenizerModel.html">
     sparknlp.annotator.TokenizerModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.TypedDependencyParserApproach.html">
     sparknlp.annotator.TypedDependencyParserApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.TypedDependencyParserModel.html">
     sparknlp.annotator.TypedDependencyParserModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.UniversalSentenceEncoder.html">
     sparknlp.annotator.UniversalSentenceEncoder
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ViveknSentimentApproach.html">
     sparknlp.annotator.ViveknSentimentApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.ViveknSentimentModel.html">
     sparknlp.annotator.ViveknSentimentModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Word2VecApproach.html">
     sparknlp.annotator.Word2VecApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.Word2VecModel.html">
     sparknlp.annotator.Word2VecModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.WordEmbeddings.html">
     sparknlp.annotator.WordEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.WordEmbeddingsModel.html">
     sparknlp.annotator.WordEmbeddingsModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.WordSegmenterApproach.html">
     sparknlp.annotator.WordSegmenterApproach
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.WordSegmenterModel.html">
     sparknlp.annotator.WordSegmenterModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.XlmRoBertaEmbeddings.html">
     sparknlp.annotator.XlmRoBertaEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.XlmRoBertaForSequenceClassification.html">
     sparknlp.annotator.XlmRoBertaForSequenceClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.XlmRoBertaForTokenClassification.html">
     sparknlp.annotator.XlmRoBertaForTokenClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.XlmRoBertaSentenceEmbeddings.html">
     sparknlp.annotator.XlmRoBertaSentenceEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.XlnetEmbeddings.html">
     sparknlp.annotator.XlnetEmbeddings
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.XlnetForSequenceClassification.html">
     sparknlp.annotator.XlnetForSequenceClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.XlnetForTokenClassification.html">
     sparknlp.annotator.XlnetForTokenClassification
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.annotator.YakeKeywordExtraction.html">
     sparknlp.annotator.YakeKeywordExtraction
    </a>
   </li>
  </ul>
 </li>
 <li class="toctree-l1 current active has-children">
  <a class="reference internal" href="sparknlp.base.html">
   sparknlp.base
  </a>
  <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/>
  <label for="toctree-checkbox-2">
   <i class="fas fa-chevron-down">
   </i>
  </label>
  <ul class="current">
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.Chunk2Doc.html">
     sparknlp.base.Chunk2Doc
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.Doc2Chunk.html">
     sparknlp.base.Doc2Chunk
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.DocumentAssembler.html">
     sparknlp.base.DocumentAssembler
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.EmbeddingsFinisher.html">
     sparknlp.base.EmbeddingsFinisher
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.Finisher.html">
     sparknlp.base.Finisher
    </a>
   </li>
   <li class="toctree-l2 current active">
    <a class="current reference internal" href="#">
     sparknlp.base.GraphFinisher
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.HasRecursiveFit.html">
     sparknlp.base.HasRecursiveFit
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.HasRecursiveTransform.html">
     sparknlp.base.HasRecursiveTransform
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.LightPipeline.html">
     sparknlp.base.LightPipeline
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.RecursivePipeline.html">
     sparknlp.base.RecursivePipeline
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.RecursivePipelineModel.html">
     sparknlp.base.RecursivePipelineModel
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.base.TokenAssembler.html">
     sparknlp.base.TokenAssembler
    </a>
   </li>
  </ul>
 </li>
 <li class="toctree-l1 has-children">
  <a class="reference internal" href="sparknlp.functions.html">
   sparknlp.functions
  </a>
  <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/>
  <label for="toctree-checkbox-3">
   <i class="fas fa-chevron-down">
   </i>
  </label>
  <ul>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.functions.explode_annotations_col.html">
     sparknlp.functions.explode_annotations_col
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.functions.filter_by_annotations_col.html">
     sparknlp.functions.filter_by_annotations_col
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.functions.map_annotations.html">
     sparknlp.functions.map_annotations
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.functions.map_annotations_array.html">
     sparknlp.functions.map_annotations_array
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.functions.map_annotations_col.html">
     sparknlp.functions.map_annotations_col
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.functions.map_annotations_cols.html">
     sparknlp.functions.map_annotations_cols
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.functions.map_annotations_strict.html">
     sparknlp.functions.map_annotations_strict
    </a>
   </li>
  </ul>
 </li>
 <li class="toctree-l1 has-children">
  <a class="reference internal" href="sparknlp.training.html">
   sparknlp.training
  </a>
  <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/>
  <label for="toctree-checkbox-4">
   <i class="fas fa-chevron-down">
   </i>
  </label>
  <ul>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.training.CoNLL.html">
     sparknlp.training.CoNLL
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.training.CoNLLU.html">
     sparknlp.training.CoNLLU
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.training.POS.html">
     sparknlp.training.POS
    </a>
   </li>
   <li class="toctree-l2">
    <a class="reference internal" href="sparknlp.training.PubTator.html">
     sparknlp.training.PubTator
    </a>
   </li>
  </ul>
 </li>
 <li class="toctree-l1 has-children">
  <a class="reference internal" href="sparknlp.logging.html">
   sparknlp.logging
  </a>
  <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/>
  <label for="toctree-checkbox-5">
   <i class="fas fa-chevron-down">
   </i>
  </label>
  <ul>
   <li class="toctree-l2 has-children">
    <a class="reference internal" href="sparknlp.logging.comet.html">
     sparknlp.logging.comet
    </a>
    <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/>
    <label for="toctree-checkbox-6">
     <i class="fas fa-chevron-down">
     </i>
    </label>
    <ul>
     <li class="toctree-l3">
      <a class="reference internal" href="sparknlp.logging.comet.CometLogger.html">
       sparknlp.logging.comet.CometLogger
      </a>
     </li>
    </ul>
   </li>
  </ul>
 </li>
</ul>

  </div>
</nav>
              </div>
              <div class="sidebar-end-items">
              </div>
            </div>
            
          

          
          <div class="d-none d-xl-block col-xl-2 bd-toc">
            
              
              <div class="toc-item">
                

<nav id="bd-toc-nav">
    
</nav>
              </div>
              
              <div class="toc-item">
                
              </div>
              
            
          </div>
          

          
          
            
          
          <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
              
              <div>
                
  <section id="sparknlp-base-graphfinisher">
<h1>sparknlp.base.GraphFinisher<a class="headerlink" href="#sparknlp-base-graphfinisher" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sparknlp.base.</span></span><span class="sig-name descname"><span class="pre">GraphFinisher</span></span><a class="reference internal" href="../../modules/sparknlp/base.html#GraphFinisher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sparknlp.base.GraphFinisher" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sparknlp.internal.AnnotatorTransformer</span></code></p>
<p>Helper class to convert the knowledge graph from GraphExtraction into a
generic format, such as RDF.</p>
<table class="table">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Input Annotation types</p></th>
<th class="head"><p>Output Annotation type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">NONE</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">NONE</span></code></p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>inputCol</strong></dt><dd><p>Name of input annotation column</p>
</dd>
<dt><strong>outputCol</strong></dt><dd><p>Name of finisher output column</p>
</dd>
<dt><strong>cleanAnnotations</strong></dt><dd><p>Whether to remove all the existing annotation columns, by default True</p>
</dd>
<dt><strong>outputAsArray</strong></dt><dd><p>Whether to generate an Array with the results, by default True</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Examples</p>
<p>This is a continuation of the example of
<a class="reference internal" href="sparknlp.annotator.GraphExtraction.html#sparknlp.annotator.GraphExtraction" title="sparknlp.annotator.GraphExtraction"><code class="xref py py-class docutils literal notranslate"><span class="pre">GraphExtraction</span></code></a>. To see how the graph is extracted, see the
documentation of that class.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">graphFinisher</span> <span class="o">=</span> <span class="n">GraphFinisher</span><span class="p">()</span> \
<span class="gp">... </span>    <span class="o">.</span><span class="n">setInputCol</span><span class="p">(</span><span class="s2">&quot;graph&quot;</span><span class="p">)</span> \
<span class="gp">... </span>    <span class="o">.</span><span class="n">setOutputCol</span><span class="p">(</span><span class="s2">&quot;graph_finished&quot;</span><span class="p">)</span>
<span class="gp">... </span>    <span class="o">.</span><span class="n">setOutputAsArray</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">finishedResult</span> <span class="o">=</span> <span class="n">graphFinisher</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">finishedResult</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="s2">&quot;text&quot;</span><span class="p">,</span> <span class="s2">&quot;graph_finished&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">truncate</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="go">+-----------------------------------------------------+-----------------------------------------------------------------------+</span>
<span class="go">|text                                                 |graph_finished                                                         |</span>
<span class="go">+-----------------------------------------------------+-----------------------------------------------------------------------+</span>
<span class="go">|You and John prefer the morning flight through Denver|[[(prefer,nsubj,morning), (morning,flat,flight), (flight,flat,Denver)]]|</span>
<span class="go">+-----------------------------------------------------+-----------------------------------------------------------------------+</span>
</pre></div>
</div>
<p class="rubric">Methods</p>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.clear" title="sparknlp.base.GraphFinisher.clear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clear</span></code></a>(param)</p></td>
<td><p>Clears a param from the param map if it has been explicitly set.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.copy" title="sparknlp.base.GraphFinisher.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>([extra])</p></td>
<td><p>Creates a copy of this instance with the same uid and some extra params.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.explainParam" title="sparknlp.base.GraphFinisher.explainParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">explainParam</span></code></a>(param)</p></td>
<td><p>Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.explainParams" title="sparknlp.base.GraphFinisher.explainParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">explainParams</span></code></a>()</p></td>
<td><p>Returns the documentation of all params with their optionally default values and user-supplied values.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.extractParamMap" title="sparknlp.base.GraphFinisher.extractParamMap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">extractParamMap</span></code></a>([extra])</p></td>
<td><p>Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values &lt; user-supplied values &lt; extra.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.getOrDefault" title="sparknlp.base.GraphFinisher.getOrDefault"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getOrDefault</span></code></a>(param)</p></td>
<td><p>Gets the value of a param in the user-supplied param map or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.getParam" title="sparknlp.base.GraphFinisher.getParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getParam</span></code></a>(paramName)</p></td>
<td><p>Gets a param by its name.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.getParamValue" title="sparknlp.base.GraphFinisher.getParamValue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getParamValue</span></code></a>(paramName)</p></td>
<td><p>Gets the value of a parameter.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.hasDefault" title="sparknlp.base.GraphFinisher.hasDefault"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hasDefault</span></code></a>(param)</p></td>
<td><p>Checks whether a param has a default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.hasParam" title="sparknlp.base.GraphFinisher.hasParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hasParam</span></code></a>(paramName)</p></td>
<td><p>Tests whether this instance contains a param with a given (string) name.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.isDefined" title="sparknlp.base.GraphFinisher.isDefined"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isDefined</span></code></a>(param)</p></td>
<td><p>Checks whether a param is explicitly set by user or has a default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.isSet" title="sparknlp.base.GraphFinisher.isSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isSet</span></code></a>(param)</p></td>
<td><p>Checks whether a param is explicitly set by user.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.load" title="sparknlp.base.GraphFinisher.load"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load</span></code></a>(path)</p></td>
<td><p>Reads an ML instance from the input path, a shortcut of <cite>read().load(path)</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.read" title="sparknlp.base.GraphFinisher.read"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read</span></code></a>()</p></td>
<td><p>Returns an MLReader instance for this class.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.save" title="sparknlp.base.GraphFinisher.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">save</span></code></a>(path)</p></td>
<td><p>Save this ML instance to the given path, a shortcut of 'write().save(path)'.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.set" title="sparknlp.base.GraphFinisher.set"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set</span></code></a>(param, value)</p></td>
<td><p>Sets a parameter in the embedded param map.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.setCleanAnnotations" title="sparknlp.base.GraphFinisher.setCleanAnnotations"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCleanAnnotations</span></code></a>(value)</p></td>
<td><p>Sets whether to remove all the existing annotation columns, by default True.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.setInputCol" title="sparknlp.base.GraphFinisher.setInputCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setInputCol</span></code></a>(value)</p></td>
<td><p>Sets name of input annotation column.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.setOutputAsArray" title="sparknlp.base.GraphFinisher.setOutputAsArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setOutputAsArray</span></code></a>(value)</p></td>
<td><p>Sets whether to generate an Array with the results, by default True.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.setOutputCol" title="sparknlp.base.GraphFinisher.setOutputCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setOutputCol</span></code></a>(value)</p></td>
<td><p>Sets name of finisher output column.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.setParamValue" title="sparknlp.base.GraphFinisher.setParamValue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setParamValue</span></code></a>(paramName)</p></td>
<td><p>Sets the value of a parameter.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">setParams</span></code>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.transform" title="sparknlp.base.GraphFinisher.transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">transform</span></code></a>(dataset[, params])</p></td>
<td><p>Transforms the input dataset with optional parameters.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.write" title="sparknlp.base.GraphFinisher.write"><code class="xref py py-obj docutils literal notranslate"><span class="pre">write</span></code></a>()</p></td>
<td><p>Returns an MLWriter instance for this ML instance.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes</p>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">cleanAnnotations</span></code></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">getter_attrs</span></code></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">inputCol</span></code></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">outputAsArray</span></code></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">outputCol</span></code></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sparknlp.base.GraphFinisher.params" title="sparknlp.base.GraphFinisher.params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">params</span></code></a></p></td>
<td><p>Returns all params ordered by name.</p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.clear">
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Clears a param from the param map if it has been explicitly set.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.copy">
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extra</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.copy" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a copy of this instance with the same uid and some
extra params. This implementation first calls Params.copy and
then make a copy of the companion Java pipeline component with
extra params. So both the Python wrapper and the Java pipeline
component get copied.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>extra</strong> – Extra parameters to copy to the new instance</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Copy of this instance</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.explainParam">
<span class="sig-name descname"><span class="pre">explainParam</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.explainParam" title="Permalink to this definition">¶</a></dt>
<dd><p>Explains a single param and returns its name, doc, and optional
default value and user-supplied value in a string.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.explainParams">
<span class="sig-name descname"><span class="pre">explainParams</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.explainParams" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the documentation of all params with their optionally
default values and user-supplied values.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.extractParamMap">
<span class="sig-name descname"><span class="pre">extractParamMap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extra</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.extractParamMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Extracts the embedded default param values and user-supplied
values, and then merges them with extra values from input into
a flat param map, where the latter value is used if there exist
conflicts, i.e., with ordering: default param values &lt;
user-supplied values &lt; extra.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>extra</strong> – extra param values</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>merged param map</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.getOrDefault">
<span class="sig-name descname"><span class="pre">getOrDefault</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.getOrDefault" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the value of a param in the user-supplied param map or its
default value. Raises an error if neither is set.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.getParam">
<span class="sig-name descname"><span class="pre">getParam</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paramName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.getParam" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a param by its name.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.getParamValue">
<span class="sig-name descname"><span class="pre">getParamValue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paramName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.getParamValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the value of a parameter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>paramName</strong><span class="classifier">str</span></dt><dd><p>Name of the parameter</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.hasDefault">
<span class="sig-name descname"><span class="pre">hasDefault</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.hasDefault" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks whether a param has a default value.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.hasParam">
<span class="sig-name descname"><span class="pre">hasParam</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paramName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.hasParam" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests whether this instance contains a param with a given
(string) name.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.isDefined">
<span class="sig-name descname"><span class="pre">isDefined</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.isDefined" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks whether a param is explicitly set by user or has
a default value.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.isSet">
<span class="sig-name descname"><span class="pre">isSet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.isSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks whether a param is explicitly set by user.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.load">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.load" title="Permalink to this definition">¶</a></dt>
<dd><p>Reads an ML instance from the input path, a shortcut of <cite>read().load(path)</cite>.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.params">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">params</span></span><a class="headerlink" href="#sparknlp.base.GraphFinisher.params" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns all params ordered by name. The default implementation
uses <code class="xref py py-func docutils literal notranslate"><span class="pre">dir()</span></code> to get all attributes of type
<code class="xref py py-class docutils literal notranslate"><span class="pre">Param</span></code>.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.read">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.read" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an MLReader instance for this class.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.save">
<span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.save" title="Permalink to this definition">¶</a></dt>
<dd><p>Save this ML instance to the given path, a shortcut of ‘write().save(path)’.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.set" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets a parameter in the embedded param map.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.setCleanAnnotations">
<span class="sig-name descname"><span class="pre">setCleanAnnotations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../modules/sparknlp/base.html#GraphFinisher.setCleanAnnotations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sparknlp.base.GraphFinisher.setCleanAnnotations" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets whether to remove all the existing annotation columns, by
default True.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>value</strong><span class="classifier">bool</span></dt><dd><p>Whether to remove all the existing annotation columns, by default True.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.setInputCol">
<span class="sig-name descname"><span class="pre">setInputCol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../modules/sparknlp/base.html#GraphFinisher.setInputCol"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sparknlp.base.GraphFinisher.setInputCol" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets name of input annotation column.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>value</strong><span class="classifier">str</span></dt><dd><p>Name of input annotation column.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.setOutputAsArray">
<span class="sig-name descname"><span class="pre">setOutputAsArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../modules/sparknlp/base.html#GraphFinisher.setOutputAsArray"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sparknlp.base.GraphFinisher.setOutputAsArray" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets whether to generate an Array with the results, by default True.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>value</strong><span class="classifier">bool</span></dt><dd><p>Whether to generate an Array with the results, by default True.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.setOutputCol">
<span class="sig-name descname"><span class="pre">setOutputCol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../modules/sparknlp/base.html#GraphFinisher.setOutputCol"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sparknlp.base.GraphFinisher.setOutputCol" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets name of finisher output column.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>value</strong><span class="classifier">str</span></dt><dd><p>Name of finisher output column.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.setParamValue">
<span class="sig-name descname"><span class="pre">setParamValue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paramName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.setParamValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the value of a parameter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>paramName</strong><span class="classifier">str</span></dt><dd><p>Name of the parameter</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.transform">
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Transforms the input dataset with optional parameters.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dataset</strong> – input dataset, which is an instance of <a class="reference external" href="https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="(in PySpark vmaster)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyspark.sql.DataFrame</span></code></a></p></li>
<li><p><strong>params</strong> – an optional param map that overrides embedded params.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>transformed dataset</p>
</dd>
</dl>
<div class="versionadded">
<p><span class="versionmodified added">New in version 1.3.0.</span></p>
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.uid">
<span class="sig-name descname"><span class="pre">uid</span></span><a class="headerlink" href="#sparknlp.base.GraphFinisher.uid" title="Permalink to this definition">¶</a></dt>
<dd><p>A unique id for the object.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sparknlp.base.GraphFinisher.write">
<span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sparknlp.base.GraphFinisher.write" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an MLWriter instance for this ML instance.</p>
</dd></dl>

</dd></dl>

</section>


              </div>
              
              
              <!-- Previous / next buttons -->
<div class='prev-next-area'>
    <a class='left-prev' id="prev-link" href="sparknlp.base.Finisher.html" title="previous page">
        <i class="fas fa-angle-left"></i>
        <div class="prev-next-info">
            <p class="prev-next-subtitle">previous</p>
            <p class="prev-next-title">sparknlp.base.Finisher</p>
        </div>
    </a>
    <a class='right-next' id="next-link" href="sparknlp.base.HasRecursiveFit.html" title="next page">
    <div class="prev-next-info">
        <p class="prev-next-subtitle">next</p>
        <p class="prev-next-title">sparknlp.base.HasRecursiveFit</p>
    </div>
    <i class="fas fa-angle-right"></i>
    </a>
</div>
              
          </main>
          

      </div>
    </div>
  
    <script src="../../static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script>
  <footer class="footer mt-5 mt-md-0">
  <div class="container">
    
    <div class="footer-item">
      <p class="copyright">
    &copy; Copyright 2021, John Snow Labs.<br>
</p>
    </div>
    
    <div class="footer-item">
      <p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.4.0.<br>
</p>
    </div>
    
  </div>
</footer>
  </body>
</html>