azure.ai.ml.automl.NlpSweepSettings.yml

### YamlMime:PythonClass
uid: azure.ai.ml.automl.NlpSweepSettings
name: NlpSweepSettings
fullName: azure.ai.ml.automl.NlpSweepSettings
module: azure.ai.ml.automl
inheritances:
- azure.ai.ml.entities._mixins.RestTranslatableMixin
summary: Sweep settings for all AutoML NLP tasks.
constructor:
  syntax: 'NlpSweepSettings(*, sampling_algorithm: str | SamplingAlgorithmType, early_termination:
    EarlyTerminationPolicy | None = None)'
  parameters:
  - name: sampling_algorithm
    description: 'Required. Specifies type of hyperparameter sampling algorithm.

      Possible values include: "Grid", "Random", and "Bayesian".'
    isRequired: true
    types:
    - <xref:typing.Union>[<xref:str>, <xref:azure.ai.ml.automl.SamplingAlgorithmType>]
  - name: early_termination
    description: 'Early termination policy to end poorly performing training candidates,

      defaults to None.'
    isRequired: true
    types:
    - <xref:typing.Optional>[<xref:azure.mgmt.machinelearningservices.models.EarlyTerminationPolicy>]
  keywordOnlyParameters:
  - name: sampling_algorithm
    isRequired: true
  - name: early_termination
    isRequired: true
examples:
- "creating an nlp sweep settings<!--[!code-python[Main](les\\ml_samples_automl_nlp.py\
  \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
  : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
  \\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-ml-1.16.1\\\
  \\samples\\\\ml_samples_automl_nlp.py\", \"xml:space\": \"preserve\", \"force\"\
  : false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
  linenos\": false} -->\n\n````python\n\n   from azure.ai.ml import automl\n   from\
  \ azure.ai.ml.sweep import BanditPolicy\n\n   nlp_sweep_settings = automl.NlpSweepSettings(\n\
  \       sampling_algorithm=\"Grid\",\n       early_termination=BanditPolicy(evaluation_interval=2,\
  \ slack_factor=0.05, delay_evaluation=6),\n   )\n\n   ````\n"