diff --git a/.buildinfo b/.buildinfo index ef1fd06..acb44a3 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 48465817e8889750dfdc44ef138c3716 +config: b2332f8eccee98961e599d75435e3581 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/example/boilerplate.html b/_modules/example/boilerplate.html index ca7bfe8..be3e8da 100644 --- a/_modules/example/boilerplate.html +++ b/_modules/example/boilerplate.html @@ -5,7 +5,7 @@ - example.boilerplate — NovelAI API 0.17.0 documentation + example.boilerplate — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

Navigation

  • modules |
  • - + @@ -177,7 +177,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/index.html b/_modules/index.html index de14bbe..c50c47a 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -5,7 +5,7 @@ - Overview: module code — NovelAI API 0.17.0 documentation + Overview: module code — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -104,7 +104,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/BanList.html b/_modules/novelai_api/BanList.html index fc4a260..97d4ffd 100644 --- a/_modules/novelai_api/BanList.html +++ b/_modules/novelai_api/BanList.html @@ -5,7 +5,7 @@ - novelai_api.BanList — NovelAI API 0.17.0 documentation + novelai_api.BanList — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -171,7 +171,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/BiasGroup.html b/_modules/novelai_api/BiasGroup.html index 39debcf..e9c592e 100644 --- a/_modules/novelai_api/BiasGroup.html +++ b/_modules/novelai_api/BiasGroup.html @@ -5,7 +5,7 @@ - novelai_api.BiasGroup — NovelAI API 0.17.0 documentation + novelai_api.BiasGroup — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -242,7 +242,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/GlobalSettings.html b/_modules/novelai_api/GlobalSettings.html index c5490a0..192353b 100644 --- a/_modules/novelai_api/GlobalSettings.html +++ b/_modules/novelai_api/GlobalSettings.html @@ -5,7 +5,7 @@ - novelai_api.GlobalSettings — NovelAI API 0.17.0 documentation + novelai_api.GlobalSettings — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -542,6 +542,25 @@

    Source code for novelai_api.GlobalSettings

                 [26523],
                 [41471],
                 [2936],
    +            [85, 85],
    +        ],
    +        "nerdstash_v2": [
    +            [3],
    +            [49356],
    +            [1431],
    +            [31715],
    +            [34387],
    +            [20765],
    +            [30702],
    +            [10691],
    +            [49333],
    +            [1266],
    +            [19438],
    +            [43145],
    +            [26523],
    +            [41471],
    +            [2936],
    +            [85, 85],
             ],
         }
     
    @@ -673,6 +692,81 @@ 

    Source code for novelai_api.GlobalSettings

                 "'",
                 '"',
                 ",",
    +            ".",
    +            ":",
    +            "\n",
    +            "ve",
    +            "s",
    +            "t",
    +            "n",
    +            "d",
    +            "ll",
    +            "re",
    +            "m",
    +            "-",
    +            "*",
    +            ")",
    +            " the",
    +            " a",
    +            " an",
    +            " and",
    +            " or",
    +            " not",
    +            " no",
    +            " is",
    +            " was",
    +            " were",
    +            " did",
    +            " does",
    +            " isn",
    +            " wasn",
    +            " weren",
    +            " didn",
    +            " doesn",
    +            " him",
    +            " her",
    +            " his",
    +            " hers",
    +            " their",
    +            " its",
    +            " could",
    +            " couldn",
    +            " should",
    +            " shouldn",
    +            " would",
    +            " wouldn",
    +            " have",
    +            " haven",
    +            " had",
    +            " hadn",
    +            " has",
    +            " hasn",
    +            " can",
    +            " cannot",
    +            " are",
    +            " aren",
    +            " will",
    +            " won",
    +            "0",
    +            "1",
    +            "2",
    +            "3",
    +            "4",
    +            "5",
    +            "6",
    +            "7",
    +            "8",
    +            "9",
    +            '."',
    +            ',"',
    +            "====",
    +            " ",
    +        ],
    +        "nerdstash_v2": [
    +            "'",
    +            '"',
    +            ",",
    +            ".",
                 ":",
                 "\n",
                 "ve",
    @@ -741,10 +835,25 @@ 

    Source code for novelai_api.GlobalSettings

                 ',"',
                 "====",
                 " ",
    +            "'t've",
    +            "'s",
    +            "'t",
    +            "'ve",
    +            "'n",
    +            "'ll",
    +            "'d",
    +            "'re",
    +            "'m",
             ],
         }
     
    -    _DINKUS_ASTERISM = BiasGroup(-0.12).add("***", "⁂")
    +    _DINKUS_ASTERISM = {
    +        "gpt2": BiasGroup(-0.12).add("***", "⁂"),
    +        "gpt2-genji": None,
    +        "pile": BiasGroup(-0.12).add("***"),
    +        "nerdstash_v1": BiasGroup(-0.08).add("***", "⁂"),
    +        "nerdstash_v2": BiasGroup(-0.08).add("***", "⁂"),
    +    }
     
         _DEFAULT_SETTINGS = {
             "generate_until_sentence": False,
    @@ -848,7 +957,13 @@ 

    Source code for novelai_api.GlobalSettings

                 settings["bad_words_ids"].extend(self._GENJI_AMBIGUOUS_TOKENS)
     
             if self._settings["bias_dinkus_asterism"]:
    -            settings["logit_bias_exp"].extend(self._DINKUS_ASTERISM.get_tokenized_entries(model))
    +            assert (
    +                tokenizer_name in self._DINKUS_ASTERISM
    +            ), f"Tokenizer {tokenizer_name} not supported with bias_dinkus_asterism"
    +
    +            bias = self._DINKUS_ASTERISM[tokenizer_name]
    +            if bias is not None:
    +                settings["logit_bias_exp"].extend(bias.get_tokenized_entries(model))
     
             if self._settings["rep_pen_whitelist"]:
                 settings["repetition_penalty_whitelist"].extend(
    @@ -887,7 +1002,7 @@ 

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/Idstore.html b/_modules/novelai_api/Idstore.html index f40d441..cf1a898 100644 --- a/_modules/novelai_api/Idstore.html +++ b/_modules/novelai_api/Idstore.html @@ -5,7 +5,7 @@ - novelai_api.Idstore — NovelAI API 0.17.0 documentation + novelai_api.Idstore — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -126,7 +126,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/ImagePreset.html b/_modules/novelai_api/ImagePreset.html index 7b3008b..07954ff 100644 --- a/_modules/novelai_api/ImagePreset.html +++ b/_modules/novelai_api/ImagePreset.html @@ -5,7 +5,7 @@ - novelai_api.ImagePreset — NovelAI API 0.17.0 documentation + novelai_api.ImagePreset — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -511,7 +511,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/Keystore.html b/_modules/novelai_api/Keystore.html index 735ad45..655d271 100644 --- a/_modules/novelai_api/Keystore.html +++ b/_modules/novelai_api/Keystore.html @@ -5,7 +5,7 @@ - novelai_api.Keystore — NovelAI API 0.17.0 documentation + novelai_api.Keystore — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -260,7 +260,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/NovelAIError.html b/_modules/novelai_api/NovelAIError.html index b6122af..d662f24 100644 --- a/_modules/novelai_api/NovelAIError.html +++ b/_modules/novelai_api/NovelAIError.html @@ -5,7 +5,7 @@ - novelai_api.NovelAIError — NovelAI API 0.17.0 documentation + novelai_api.NovelAIError — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -105,7 +105,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/NovelAI_API.html b/_modules/novelai_api/NovelAI_API.html index a561c3a..2cb34b1 100644 --- a/_modules/novelai_api/NovelAI_API.html +++ b/_modules/novelai_api/NovelAI_API.html @@ -5,7 +5,7 @@ - novelai_api.NovelAI_API — NovelAI API 0.17.0 documentation + novelai_api.NovelAI_API — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -194,7 +194,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/Preset.html b/_modules/novelai_api/Preset.html index 05552c3..f2cdfb0 100644 --- a/_modules/novelai_api/Preset.html +++ b/_modules/novelai_api/Preset.html @@ -5,7 +5,7 @@ - novelai_api.Preset — NovelAI API 0.17.0 documentation + novelai_api.Preset — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -71,7 +71,8 @@

    Source code for novelai_api.Preset

         Top_P = 2
         TFS = 3
         Top_A = 4
    -    Typical_P = 5
    + Typical_P = 5 + CFG = 6
    NAME_TO_ORDER = { @@ -81,6 +82,7 @@

    Source code for novelai_api.Preset

         "tfs": Order.TFS,
         "top_a": Order.Top_A,
         "typical_p": Order.Typical_P,
    +    "cfg": Order.CFG,
     }
     
     ORDER_TO_NAME = {
    @@ -90,6 +92,7 @@ 

    Source code for novelai_api.Preset

         Order.TFS: "tfs",
         Order.Top_A: "top_a",
         Order.Typical_P: "typical_p",
    +    Order.CFG: "cfg",
     }
     
     
    @@ -149,6 +152,7 @@ 

    Source code for novelai_api.Preset

         Krake = "krake-v2"
     
         Clio = "clio-v1"
    +    Kayra = "kayra-v1"
     
         Genji = "genji-jp-6b-v2"
         Snek = "genji-python-6b"
    @@ -157,6 +161,15 @@ 

    Source code for novelai_api.Preset

         Inline = "infillmodel"
    +
    [docs]class PhraseRepPen(StrEnum): + Off = "off" + VeryLight = "very_light" + Light = "light" + Medium = "medium" + Aggressive = "aggressive" + VeryAggressive = "very_aggressive"
    + + #: Prompt sent to the model when the context is empty PREAMBLE = { # Model.Calliope: "⁂\n", @@ -166,6 +179,7 @@

    Source code for novelai_api.Preset

         Model.Euterpe: "\n***\n",
         Model.Krake: "<|endoftext|>[ Prologue ]\n",
         Model.Clio: "[ Author: Various ]\n[ Prologue ]\n",
    +    Model.Kayra: "",  # no preamble, it uses the "special_openings" module instead
     }
     
     
    @@ -215,9 +229,13 @@ 

    Source code for novelai_api.Preset

             "repetition_penalty_frequency": (int, float),
             "repetition_penalty_presence": (int, float),
             "repetition_penalty_whitelist": list,
    +        "repetition_penalty_default_whitelist": bool,
    +        "phrase_rep_pen": (str, PhraseRepPen),
             "length_penalty": (int, float),
             "diversity_penalty": (int, float),
             "order": list,
    +        "cfg_scale": (int, float),
    +        "cfg_uc": str,
             "pad_token_id": int,
             "bos_token_id": int,
             "eos_token_id": int,
    @@ -244,9 +262,11 @@ 

    Source code for novelai_api.Preset

             "repetition_penalty_frequency": 0.0,
             "repetition_penalty_presence": 0.0,
             "repetition_penalty_whitelist": [],
    +        "repetition_penalty_default_whitelist": False,
             "length_penalty": 1.0,
             "diversity_penalty": 0.0,
             "order": list(Order),
    +        "phrase_rep_pen": PhraseRepPen.Off,
         }
     
         # type completion for __setitem__ and __getitem__
    @@ -284,12 +304,21 @@ 

    Source code for novelai_api.Preset

             repetition_penalty_presence: float
             #: List of tokens that are excluded from the repetition penalty (useful for colors and the likes)
             repetition_penalty_whitelist: list
    +        #: Whether to use the default whitelist. Used for presets compatibility, as this setting is saved in presets
    +        repetition_penalty_default_whitelist: bool
    +        #: https://docs.novelai.net/text/phrasereppen.html
    +        phrase_rep_pen: Union[str, PhraseRepPen]
             #: https://huggingface.co/docs/transformers/main_classes/configuration#transformers.PretrainedConfig
             length_penalty: float
             #: https://huggingface.co/docs/transformers/main_classes/configuration#transformers.PretrainedConfig
             diversity_penalty: float
             #: list of Order to set the sampling order
             order: List[Union[Order, int]]
    +        #: https://docs.novelai.net/text/cfg.html
    +        cfg_scale: float
    +        #: https://docs.novelai.net/text/cfg.html
    +        cfg_uc: str
    +
             #: https://huggingface.co/docs/transformers/main_classes/text_generation#transformers.GenerationConfig
             pad_token_id: int
             #: https://huggingface.co/docs/transformers/main_classes/text_generation#transformers.GenerationConfig
    @@ -381,7 +410,7 @@ 

    Source code for novelai_api.Preset

     
         def __repr__(self) -> str:
             model = self.model.value if self.model is not None else "<?>"
    -        enabled_keys = ", ".join(f"{k} = {v}" for k, v in zip(self._enabled, NAME_TO_ORDER.keys()))
    +        enabled_keys = ", ".join(f"{k} = {v}" for v, k in zip(self._enabled, NAME_TO_ORDER.keys()))
     
             return f"Preset: '{self.name} ({model}, {enabled_keys})'"
     
    @@ -428,6 +457,14 @@ 

    Source code for novelai_api.Preset

     
                 settings["order"] = [e.value for e in settings["order"]]
     
    +        # sanitize Phrase Repetition Penalty
    +        if settings.get("phrase_rep_pen", None) is not None:
    +            prp = settings.pop("phrase_rep_pen")
    +            if not isinstance(prp, PhraseRepPen):
    +                prp = PhraseRepPen(prp)
    +
    +            settings["phrase_rep_pen"] = prp.value
    +
             # seems that 0 doesn't disable it, but does weird things
             if settings.get("repetition_penalty_range", None) == 0:
                 del settings["repetition_penalty_range"]
    @@ -646,7 +683,7 @@ 

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/SchemaValidator.html b/_modules/novelai_api/SchemaValidator.html index f7b4e40..b4cd5e7 100644 --- a/_modules/novelai_api/SchemaValidator.html +++ b/_modules/novelai_api/SchemaValidator.html @@ -5,7 +5,7 @@ - novelai_api.SchemaValidator — NovelAI API 0.17.0 documentation + novelai_api.SchemaValidator — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -121,7 +121,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/StoryHandler.html b/_modules/novelai_api/StoryHandler.html index 023987a..87496f5 100644 --- a/_modules/novelai_api/StoryHandler.html +++ b/_modules/novelai_api/StoryHandler.html @@ -5,7 +5,7 @@ - novelai_api.StoryHandler — NovelAI API 0.17.0 documentation + novelai_api.StoryHandler — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -551,7 +551,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/Tokenizer.html b/_modules/novelai_api/Tokenizer.html index 9226472..b47d670 100644 --- a/_modules/novelai_api/Tokenizer.html +++ b/_modules/novelai_api/Tokenizer.html @@ -5,7 +5,7 @@ - novelai_api.Tokenizer — NovelAI API 0.17.0 documentation + novelai_api.Tokenizer — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -187,6 +187,7 @@

    Source code for novelai_api.Tokenizer

             Model.HypeBot: "gpt2",
             Model.Inline: "gpt2",
             Model.Clio: "nerdstash_v1",
    +        Model.Kayra: "nerdstash_v2",
             ImageModel.Anime_Curated: "clip",
             ImageModel.Anime_Full: "clip",
             ImageModel.Furry: "clip",
    @@ -297,7 +298,7 @@ 

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/_high_level.html b/_modules/novelai_api/_high_level.html index 36a0d05..815b0cf 100644 --- a/_modules/novelai_api/_high_level.html +++ b/_modules/novelai_api/_high_level.html @@ -5,7 +5,7 @@ - novelai_api._high_level — NovelAI API 0.17.0 documentation + novelai_api._high_level — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -333,13 +333,21 @@

    Source code for novelai_api._high_level

                 raise ValueError(f"Preset '{preset.name}' (model {preset.model}) is not compatible with model {model}")
     
             preset_params = preset.to_settings()
    -        global_params = global_settings.to_settings(model)
     
    -        params = {}
    +        # special case for repetition penalty whitelist, as it belongs to global settings but is stored in preset files
    +        repetition_penalty_default_whitelist = global_settings.rep_pen_whitelist
    +        if preset_params.pop("repetition_penalty_default_whitelist", False):
    +            global_settings.rep_pen_whitelist = True
    +
    +        global_params = global_settings.to_settings(model)
    +        global_settings.rep_pen_whitelist = repetition_penalty_default_whitelist
     
    -        # merge rep pen whitelist if both are set
    -        if "repetition_penalty_whitelist" in preset_params and "repetition_penalty_whitelist" in global_params:
    -            preset_params["repetition_penalty_whitelist"] += global_params.pop("repetition_penalty_whitelist")
    +        params = {
    +            "repetition_penalty_whitelist": [
    +                *global_params.pop("repetition_penalty_whitelist", []),
    +                *preset_params.pop("repetition_penalty_whitelist", []),
    +            ]
    +        }
     
             params.update(preset_params)
             params.update(global_params)
    @@ -526,7 +534,7 @@ 

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/_low_level.html b/_modules/novelai_api/_low_level.html index 96ddf43..cbb696e 100644 --- a/_modules/novelai_api/_low_level.html +++ b/_modules/novelai_api/_low_level.html @@ -5,7 +5,7 @@ - novelai_api._low_level — NovelAI API 0.17.0 documentation + novelai_api._low_level — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -995,7 +995,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/novelai_api/utils.html b/_modules/novelai_api/utils.html index c279d28..4fb57c2 100644 --- a/_modules/novelai_api/utils.html +++ b/_modules/novelai_api/utils.html @@ -5,7 +5,7 @@ - novelai_api.utils — NovelAI API 0.17.0 documentation + novelai_api.utils — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -456,7 +456,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/tests/api/boilerplate.html b/_modules/tests/api/boilerplate.html index 570f54a..25400c5 100644 --- a/_modules/tests/api/boilerplate.html +++ b/_modules/tests/api/boilerplate.html @@ -5,7 +5,7 @@ - tests.api.boilerplate — NovelAI API 0.17.0 documentation + tests.api.boilerplate — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -251,7 +251,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/tests/api/test_decrypt_encrypt_integrity_check.html b/_modules/tests/api/test_decrypt_encrypt_integrity_check.html index 92e1c6e..5dce862 100644 --- a/_modules/tests/api/test_decrypt_encrypt_integrity_check.html +++ b/_modules/tests/api/test_decrypt_encrypt_integrity_check.html @@ -5,7 +5,7 @@ - tests.api.test_decrypt_encrypt_integrity_check — NovelAI API 0.17.0 documentation + tests.api.test_decrypt_encrypt_integrity_check — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -307,7 +307,7 @@

    Navigation

  • modules |
  • - + diff --git a/_modules/tests/api/test_textgen_presets.html b/_modules/tests/api/test_textgen_presets.html index 61b5a4a..c11224c 100644 --- a/_modules/tests/api/test_textgen_presets.html +++ b/_modules/tests/api/test_textgen_presets.html @@ -5,7 +5,7 @@ - tests.api.test_textgen_presets — NovelAI API 0.17.0 documentation + tests.api.test_textgen_presets — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - + @@ -144,7 +144,7 @@

    Navigation

  • modules |
  • - + diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 4169bb2..4db48ae 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.17.0', + VERSION: '0.18.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/example/example.boilerplate.html b/example/example.boilerplate.html index 5c4065e..d86d829 100644 --- a/example/example.boilerplate.html +++ b/example/example.boilerplate.html @@ -6,7 +6,7 @@ - boilerplate — NovelAI API 0.17.0 documentation + boilerplate — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -198,7 +198,7 @@

    Navigation

  • previous |
  • - + diff --git a/example/example.html b/example/example.html index d95792b..59b8287 100644 --- a/example/example.html +++ b/example/example.html @@ -6,7 +6,7 @@ - example directory — NovelAI API 0.17.0 documentation + example directory — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - +
    @@ -284,7 +284,7 @@

    Navigation

  • previous |
  • - +
    diff --git a/genindex.html b/genindex.html index 4d2cc46..08d8285 100644 --- a/genindex.html +++ b/genindex.html @@ -5,7 +5,7 @@ - Index — NovelAI API 0.17.0 documentation + Index — NovelAI API 0.18.0 documentation @@ -43,7 +43,7 @@

    Navigation

  • modules |
  • - +
    @@ -134,6 +134,8 @@

    A

  • add_original_image (ImagePreset attribute) +
  • +
  • Aggressive (PhraseRepPen attribute)
  • aimodules_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)
  • @@ -210,6 +212,12 @@

    C

    + - - +
    diff --git a/novelai_api/novelai_api.BanList.html b/novelai_api/novelai_api.BanList.html index 9ab8250..d3bcab4 100644 --- a/novelai_api/novelai_api.BanList.html +++ b/novelai_api/novelai_api.BanList.html @@ -6,7 +6,7 @@ - novelai_api.BanList — NovelAI API 0.17.0 documentation + novelai_api.BanList — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -177,7 +177,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.BiasGroup.html b/novelai_api/novelai_api.BiasGroup.html index cf3df9c..d393b4e 100644 --- a/novelai_api/novelai_api.BiasGroup.html +++ b/novelai_api/novelai_api.BiasGroup.html @@ -6,7 +6,7 @@ - novelai_api.BiasGroup — NovelAI API 0.17.0 documentation + novelai_api.BiasGroup — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -206,7 +206,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.GlobalSettings.html b/novelai_api/novelai_api.GlobalSettings.html index 6bacc89..6487dee 100644 --- a/novelai_api/novelai_api.GlobalSettings.html +++ b/novelai_api/novelai_api.GlobalSettings.html @@ -6,7 +6,7 @@ - novelai_api.GlobalSettings — NovelAI API 0.17.0 documentation + novelai_api.GlobalSettings — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -213,7 +213,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.Idstore.html b/novelai_api/novelai_api.Idstore.html index 5c7aa55..c3149b0 100644 --- a/novelai_api/novelai_api.Idstore.html +++ b/novelai_api/novelai_api.Idstore.html @@ -6,7 +6,7 @@ - novelai_api.Idstore — NovelAI API 0.17.0 documentation + novelai_api.Idstore — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -163,7 +163,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.ImagePreset.html b/novelai_api/novelai_api.ImagePreset.html index b8fbafb..92ee8a8 100644 --- a/novelai_api/novelai_api.ImagePreset.html +++ b/novelai_api/novelai_api.ImagePreset.html @@ -6,7 +6,7 @@ - novelai_api.ImagePreset — NovelAI API 0.17.0 documentation + novelai_api.ImagePreset — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -672,7 +672,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.Keystore.html b/novelai_api/novelai_api.Keystore.html index d789f97..df363d8 100644 --- a/novelai_api/novelai_api.Keystore.html +++ b/novelai_api/novelai_api.Keystore.html @@ -6,7 +6,7 @@ - novelai_api.Keystore — NovelAI API 0.17.0 documentation + novelai_api.Keystore — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -181,7 +181,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.NovelAIError.html b/novelai_api/novelai_api.NovelAIError.html index 767d262..53e56f9 100644 --- a/novelai_api/novelai_api.NovelAIError.html +++ b/novelai_api/novelai_api.NovelAIError.html @@ -6,7 +6,7 @@ - novelai_api.NovelAIError — NovelAI API 0.17.0 documentation + novelai_api.NovelAIError — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -166,7 +166,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.NovelAI_API.html b/novelai_api/novelai_api.NovelAI_API.html index a28fb59..e6351cd 100644 --- a/novelai_api/novelai_api.NovelAI_API.html +++ b/novelai_api/novelai_api.NovelAI_API.html @@ -6,7 +6,7 @@ - novelai_api.NovelAI_API — NovelAI API 0.17.0 documentation + novelai_api.NovelAI_API — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -246,7 +246,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.Preset.html b/novelai_api/novelai_api.Preset.html index 383ef29..0fe45d1 100644 --- a/novelai_api/novelai_api.Preset.html +++ b/novelai_api/novelai_api.Preset.html @@ -6,7 +6,7 @@ - novelai_api.Preset — NovelAI API 0.17.0 documentation + novelai_api.Preset — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -100,6 +100,11 @@

    Navigation

    Typical_P = 5
    +
    +
    +CFG = 6
    +
    +
    @@ -162,6 +167,11 @@

    Navigation

    Clio = 'clio-v1'
    +
    +
    +Kayra = 'kayra-v1'
    +
    +
    Genji = 'genji-jp-6b-v2'
    @@ -184,14 +194,51 @@

    Navigation

    -enum_member_values = {'6B': Model.Sigurd, 'clio': Model.Clio, 'euterpe': Model.Euterpe, 'genji-jp-6b': Model.Genji, 'genji-python-6b': Model.Snek, 'hypebot': Model.HypeBot, 'infillmodel': Model.Inline, 'krake': Model.Krake}
    +enum_member_values = {'6B': Model.Sigurd, 'clio': Model.Clio, 'euterpe': Model.Euterpe, 'genji-jp-6b': Model.Genji, 'genji-python-6b': Model.Snek, 'hypebot': Model.HypeBot, 'infillmodel': Model.Inline, 'kayra': Model.Kayra, 'krake': Model.Krake} +
    + +
    + +
    +
    +class PhraseRepPen[source]
    +

    Bases: novelai_api.Preset.StrEnum

    +

    An enumeration.

    +
    +
    +Off = 'off'
    +
    + +
    +
    +VeryLight = 'very_light'
    +
    + +
    +
    +Light = 'light'
    +
    + +
    +
    +Medium = 'medium'
    +
    + +
    +
    +Aggressive = 'aggressive'
    +
    + +
    +
    +VeryAggressive = 'very_aggressive'
    -PREAMBLE = {Model.Sigurd: '⁂\n', Model.Clio: '[ Author: Various ]\n[ Prologue ]\n', Model.Euterpe: '\n***\n', Model.Genji: [60, 198, 198], Model.Snek: '<|endoftext|>\n', Model.Krake: '<|endoftext|>[ Prologue ]\n'}
    +PREAMBLE = {Model.Sigurd: '⁂\n', Model.Clio: '[ Author: Various ]\n[ Prologue ]\n', Model.Euterpe: '\n***\n', Model.Genji: [60, 198, 198], Model.Snek: '<|endoftext|>\n', Model.Kayra: '', Model.Krake: '<|endoftext|>[ Prologue ]\n'}

    Prompt sent to the model when the context is empty

    @@ -217,7 +264,7 @@

    Navigation

    Bases: object

    -DEFAULTS = {'diversity_penalty': 0.0, 'length_penalty': 1.0, 'max_length': 40, 'min_length': 1, 'order': [<Order.Temperature: 0>, <Order.Top_K: 1>, <Order.Top_P: 2>, <Order.TFS: 3>, <Order.Top_A: 4>, <Order.Typical_P: 5>], 'repetition_penalty': 1.0, 'repetition_penalty_frequency': 0.0, 'repetition_penalty_presence': 0.0, 'repetition_penalty_range': 0, 'repetition_penalty_slope': 0.0, 'repetition_penalty_whitelist': [], 'stop_sequences': [], 'tail_free_sampling': 1.0, 'temperature': 1.0, 'top_a': 1.0, 'top_k': 0, 'top_p': 0.0, 'typical_p': 0.0}
    +DEFAULTS = {'diversity_penalty': 0.0, 'length_penalty': 1.0, 'max_length': 40, 'min_length': 1, 'order': [<Order.Temperature: 0>, <Order.Top_K: 1>, <Order.Top_P: 2>, <Order.TFS: 3>, <Order.Top_A: 4>, <Order.Typical_P: 5>, <Order.CFG: 6>], 'phrase_rep_pen': PhraseRepPen.Off, 'repetition_penalty': 1.0, 'repetition_penalty_default_whitelist': False, 'repetition_penalty_frequency': 0.0, 'repetition_penalty_presence': 0.0, 'repetition_penalty_range': 0, 'repetition_penalty_slope': 0.0, 'repetition_penalty_whitelist': [], 'stop_sequences': [], 'tail_free_sampling': 1.0, 'temperature': 1.0, 'top_a': 1.0, 'top_k': 0, 'top_p': 0.0, 'typical_p': 0.0}
    @@ -310,6 +357,18 @@

    Navigation

    List of tokens that are excluded from the repetition penalty (useful for colors and the likes)

    +
    +
    +repetition_penalty_default_whitelist: bool
    +

    Whether to use the default whitelist. Used for presets compatibility, as this setting is saved in presets

    +
    + +
    +
    +phrase_rep_pen: Union[str, novelai_api.Preset.PhraseRepPen]
    +

    https://docs.novelai.net/text/phrasereppen.html

    +
    +
    length_penalty: float
    @@ -328,6 +387,18 @@

    Navigation

    list of Order to set the sampling order

    +
    +
    +cfg_scale: float
    +

    https://docs.novelai.net/text/cfg.html

    +
    + +
    +
    +cfg_uc: str
    +

    https://docs.novelai.net/text/cfg.html

    +
    +
    pad_token_id: int
    @@ -516,6 +587,7 @@

    Table of Contents

  • Order.TFS
  • Order.Top_A
  • Order.Typical_P
  • +
  • Order.CFG
  • enum_contains()
  • @@ -526,6 +598,7 @@

    Table of Contents

  • Model.Euterpe
  • Model.Krake
  • Model.Clio
  • +
  • Model.Kayra
  • Model.Genji
  • Model.Snek
  • Model.HypeBot
  • @@ -533,6 +606,15 @@

    Table of Contents

  • Model.enum_member_values
  • +
  • PhraseRepPen +
  • PREAMBLE
  • PresetView diff --git a/novelai_api/novelai_api.SchemaValidator.html b/novelai_api/novelai_api.SchemaValidator.html index 4a722a9..81f8f59 100644 --- a/novelai_api/novelai_api.SchemaValidator.html +++ b/novelai_api/novelai_api.SchemaValidator.html @@ -6,7 +6,7 @@ - novelai_api.SchemaValidator — NovelAI API 0.17.0 documentation + novelai_api.SchemaValidator — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -150,7 +150,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.StoryHandler.html b/novelai_api/novelai_api.StoryHandler.html index 81a5113..a1816ae 100644 --- a/novelai_api/novelai_api.StoryHandler.html +++ b/novelai_api/novelai_api.StoryHandler.html @@ -6,7 +6,7 @@ - novelai_api.StoryHandler — NovelAI API 0.17.0 documentation + novelai_api.StoryHandler — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -381,7 +381,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.Tokenizer.html b/novelai_api/novelai_api.Tokenizer.html index 2c3ccd0..a4e3354 100644 --- a/novelai_api/novelai_api.Tokenizer.html +++ b/novelai_api/novelai_api.Tokenizer.html @@ -6,7 +6,7 @@ - novelai_api.Tokenizer — NovelAI API 0.17.0 documentation + novelai_api.Tokenizer — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -253,7 +253,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.high_level.html b/novelai_api/novelai_api.high_level.html index 1b12f31..ddfaa58 100644 --- a/novelai_api/novelai_api.high_level.html +++ b/novelai_api/novelai_api.high_level.html @@ -6,7 +6,7 @@ - novelai_api.high_level — NovelAI API 0.17.0 documentation + novelai_api.high_level — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -396,7 +396,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.html b/novelai_api/novelai_api.html index 6e122fa..0916d63 100644 --- a/novelai_api/novelai_api.html +++ b/novelai_api/novelai_api.html @@ -6,7 +6,7 @@ - novelai-api package — NovelAI API 0.17.0 documentation + novelai-api package — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -119,6 +119,7 @@

    novelai-api packagecollapse_model()
  • StrEnum
  • Model
  • +
  • PhraseRepPen
  • PREAMBLE
  • PresetView
  • Preset
  • @@ -214,7 +215,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.low_level.html b/novelai_api/novelai_api.low_level.html index fcb9863..f0836ea 100644 --- a/novelai_api/novelai_api.low_level.html +++ b/novelai_api/novelai_api.low_level.html @@ -6,7 +6,7 @@ - novelai_api.low_level — NovelAI API 0.17.0 documentation + novelai_api.low_level — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -699,7 +699,7 @@

    Navigation

  • previous |
  • - + diff --git a/novelai_api/novelai_api.utils.html b/novelai_api/novelai_api.utils.html index fd8cb07..85757e8 100644 --- a/novelai_api/novelai_api.utils.html +++ b/novelai_api/novelai_api.utils.html @@ -6,7 +6,7 @@ - novelai_api.utils — NovelAI API 0.17.0 documentation + novelai_api.utils — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -258,7 +258,7 @@

    Navigation

  • previous |
  • - + diff --git a/objects.inv b/objects.inv index f3cc338..be728ea 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html index 9e93f8e..d5a689a 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -5,7 +5,7 @@ - Python Module Index — NovelAI API 0.17.0 documentation + Python Module Index — NovelAI API 0.18.0 documentation @@ -46,7 +46,7 @@

    Navigation

  • modules |
  • - + @@ -305,7 +305,7 @@

    Navigation

  • modules |
  • - + diff --git a/search.html b/search.html index c054812..eace18c 100644 --- a/search.html +++ b/search.html @@ -5,7 +5,7 @@ - Search — NovelAI API 0.17.0 documentation + Search — NovelAI API 0.18.0 documentation @@ -49,7 +49,7 @@

    Navigation

  • modules |
  • - + @@ -109,7 +109,7 @@

    Navigation

  • modules |
  • - + diff --git a/searchindex.js b/searchindex.js index d5e2d77..c1c5fe8 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["example/example", "example/example.boilerplate", "index", "novelai_api/novelai_api", "novelai_api/novelai_api.BanList", "novelai_api/novelai_api.BiasGroup", "novelai_api/novelai_api.GlobalSettings", "novelai_api/novelai_api.Idstore", "novelai_api/novelai_api.ImagePreset", "novelai_api/novelai_api.Keystore", "novelai_api/novelai_api.NovelAIError", "novelai_api/novelai_api.NovelAI_API", "novelai_api/novelai_api.Preset", "novelai_api/novelai_api.SchemaValidator", "novelai_api/novelai_api.StoryHandler", "novelai_api/novelai_api.Tokenizer", "novelai_api/novelai_api.high_level", "novelai_api/novelai_api.low_level", "novelai_api/novelai_api.utils", "tests/api/api", "tests/api/api.boilerplate", "tests/mock/mock"], "filenames": ["example/example.rst", "example/example.boilerplate.rst", "index.rst", "novelai_api/novelai_api.rst", "novelai_api/novelai_api.BanList.rst", "novelai_api/novelai_api.BiasGroup.rst", "novelai_api/novelai_api.GlobalSettings.rst", "novelai_api/novelai_api.Idstore.rst", "novelai_api/novelai_api.ImagePreset.rst", "novelai_api/novelai_api.Keystore.rst", "novelai_api/novelai_api.NovelAIError.rst", "novelai_api/novelai_api.NovelAI_API.rst", "novelai_api/novelai_api.Preset.rst", "novelai_api/novelai_api.SchemaValidator.rst", "novelai_api/novelai_api.StoryHandler.rst", "novelai_api/novelai_api.Tokenizer.rst", "novelai_api/novelai_api.high_level.rst", "novelai_api/novelai_api.low_level.rst", "novelai_api/novelai_api.utils.rst", "tests/api/api.rst", "tests/api/api.boilerplate.rst", "tests/mock/mock.rst"], "titles": ["example directory", "boilerplate", "novelai-api", "novelai-api package", "novelai_api.BanList", "novelai_api.BiasGroup", "novelai_api.GlobalSettings", "novelai_api.Idstore", "novelai_api.ImagePreset", "novelai_api.Keystore", "novelai_api.NovelAIError", "novelai_api.NovelAI_API", "novelai_api.Preset", "novelai_api.SchemaValidator", "novelai_api.StoryHandler", "novelai_api.Tokenizer", "novelai_api.high_level", "novelai_api.low_level", "novelai_api.utils", "API directory", "boilerplate", "Mock directory"], "terms": {"nai_usernam": [0, 1, 19], "nai_password": [0, 1, 19], "valu": [0, 5, 6, 8, 12, 17, 19], "provid": [0, 7, 8, 10, 12, 15, 17, 19, 20], "via": [0, 16, 19], "environ": [0, 1, 19], "variabl": [0, 1, 19], "thei": [0, 19], "can": [0, 1, 2, 4, 5, 11, 16, 18, 19], "through": [0, 2, 16, 17, 19], "env": [0, 19], "file": [0, 8, 12, 19], "root": [0, 19], "project": [0, 19], "The": [0, 2, 8, 9, 11, 12, 16, 17, 19, 20], "nai_proxi": [0, 19], "i": [0, 2, 4, 5, 6, 8, 9, 12, 15, 16, 17, 18, 19, 20], "also": [0, 8, 16, 19], "support": [0, 1, 17, 19, 20], "inject": [0, 19], "proxi": [0, 11, 14, 19], "address": [0, 1, 11, 17, 19], "If": [0, 16, 18], "you": [0, 2, 16], "have": [0, 16, 18], "novelai": [0, 8, 11, 16, 17], "api": [0, 1, 10, 11, 12, 14, 16, 17, 18, 20], "packag": [0, 2], "instal": [0, 2, 19], "pip": [0, 2], "python": [0, 2, 12], "filenam": [0, 19], "don": 0, "t": [0, 2, 7, 14, 15, 17, 18], "re": [0, 15, 16], "activ": [0, 2], "develop": 0, "poetri": [0, 2, 19], "run": [0, 2, 19, 20], "rememb": [0, 19], "befor": [0, 2, 16, 17, 19, 20], "alreadi": [0, 18, 19], "done": [0, 16, 17, 19], "how": [0, 17], "download": [0, 2, 16, 17, 19], "decrypt": [0, 2, 9, 16, 18, 19], "modul": [0, 16, 17], "from": [0, 2, 5, 6, 8, 9, 12, 14, 16, 17, 18], "account": [0, 2, 6, 8, 16, 17], "decompress": [0, 18, 19], "shelv": [0, 19], "stori": [0, 14, 16, 18, 19], "queri": 0, "controlnet": [0, 8, 17], "mask": [0, 8, 17], "an": [0, 5, 6, 8, 11, 12, 17, 18, 20], "imag": [0, 8, 16, 17], "It": [0, 2], "expect": [0, 10], "result": [0, 19], "png": [0, 8, 17], "exist": [0, 14, 16], "gener": [0, 6, 8, 12, 14, 16, 17], "thi": [0, 2, 11, 14, 15, 16, 17, 19], "same": [0, 12], "folder": [0, 19], "note": 0, "current": [0, 6, 8, 11, 12, 17, 19], "return": [0, 4, 5, 6, 7, 8, 12, 14, 15, 16, 17, 18], "wrong": [0, 17], "due": 0, "convers": 0, "frontend": [0, 2], "see": 0, "issu": 0, "15": 0, "place": 0, "name": [0, 12, 13, 15, 16, 17, 19], "test": [0, 19, 20], "which": [0, 11, 19], "sampler": [0, 8, 19], "work": [0, 2, 8, 11, 12, 19], "creat": [0, 4, 5, 6, 7, 8, 9, 11, 14], "one": [0, 2, 8, 12, 16, 17], "per": 0, "control": 0, "net": [0, 2, 8, 11], "img2img": [0, 8], "text": [0, 2, 6, 15, 16, 17], "direct": 0, "standard": 0, "error": [0, 10, 16, 20], "output": [0, 2, 17], "stderr": 0, "voic": [0, 17], "tt": [0, 17], "To": [0, 2, 16, 17], "speech": [0, 17], "audio": [0, 17], "sampl": [0, 8, 12], "input": [0, 2, 17], "limit": [0, 16, 17], "1000": [0, 17], "charact": [0, 17], "cut": [0, 17], "backend": [0, 17], "tag": [0, 17], "suggest": [0, 17], "gen": [0, 17], "upscal": [0, 17], "should": [0, 2, 9, 12, 14, 16, 17], "512x768": 0, "default": [0, 1, 8, 11, 12, 17, 20], "modifi": 0, "image_s": 0, "chang": [0, 8, 17], "boilerpl": [0, 19], "jsonencod": [0, 1, 19, 20], "dump": [0, 1, 19, 20], "class": [1, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 19, 20], "sourc": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20], "base": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 20], "object": [1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20], "redund": 1, "part": 1, "us": [1, 4, 5, 6, 8, 11, 12, 15, 16, 17, 19, 20], "context": [1, 12, 16, 17], "manag": [1, 2, 8], "automat": 1, "login": [1, 2, 16, 17], "usag": 1, "async": [1, 14, 16, 17, 19, 20], "encryption_kei": [1, 20], "logger": [1, 11, 20], "do": [1, 20], "stuff": 1, "A": [1, 2, 16, 17], "custom": 1, "pass": [1, 2, 16, 17], "constructor": [1, 19], "replac": [1, 14], "base_address": [1, 11], "__init__": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 20], "option": [1, 8, 9, 11, 12, 14, 16, 17, 18, 20], "str": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20], "none": [1, 8, 10, 11, 12, 14, 16, 17, 18, 20], "log": [1, 11, 16, 17, 20], "novelai_api": [1, 2, 3, 20], "novelaiapi": [1, 2, 3, 11, 14, 16, 17, 20], "properti": [1, 11, 20], "json": [1, 20], "encod": [1, 2, 8, 15, 16, 17, 18, 20], "extend": [1, 20], "byte": [1, 8, 9, 12, 14, 16, 17, 18, 20], "o": [1, 8, 12, 15, 18, 20], "ani": [1, 2, 5, 6, 8, 9, 12, 13, 14, 16, 17, 18, 20], "e": [1, 20], "shortcut": [1, 20], "configur": [1, 8, 12, 20], "consist": [1, 19, 20], "rest": 2, "intend": 2, "helper": [2, 11], "": [2, 15, 16, 17, 19], "categori": 2, "badg": 2, "pypi": 2, "qualiti": 2, "stat": 2, "endpoint": [2, 17], "m": 2, "get_access_kei": [2, 3, 18], "usernam": [2, 16], "password": [2, 16, 18], "valid": [2, 12, 13, 17], "30": 2, "dai": 2, "requir": 2, "most": [2, 16, 17], "get_access_token": 2, "user": [2, 16], "content": [2, 16, 17, 18], "print": [2, 17], "what": 2, "couldn": 2, "sanity_check": 2, "b64": [2, 8, 16, 17, 18], "model": [2, 3, 4, 5, 6, 8, 12, 14, 15, 16, 17, 18], "data": [2, 5, 9, 12, 16, 17, 18], "full": 2, "list": [2, 4, 5, 12, 14, 15, 16, 17, 18], "avail": 2, "directori": 2, "split": 2, "2": [2, 8, 12, 14, 17], "group": [2, 5], "low": [2, 11, 17], "level": [2, 11, 16, 17], "interfac": 2, "strict": 2, "implement": [2, 17], "offici": [2, 12], "http": [2, 8, 11, 12], "onli": [2, 5, 12, 17, 19], "type": [2, 8, 16, 17], "assert": 2, "schema": [2, 17], "is_schema_validation_en": [2, 17], "true": [2, 4, 5, 12, 16, 17], "high": [2, 8, 11, 16], "build": [2, 16, 17], "easier": 2, "handl": [2, 15, 20], "complex": 2, "set": [2, 6, 8, 12, 16, 17], "mani": 2, "task": 2, "all": [2, 16, 17, 19], "relev": [2, 12, 16, 17], "ar": [2, 12, 16, 17], "venv": 2, "featur": 2, "enhanc": 2, "pr": 2, "pre": [2, 16], "commit": 2, "submiss": 2, "hook": 2, "nai": [2, 8, 10, 19], "warn": [2, 17], "wip": 2, "doe": [2, 14, 18], "yet": [2, 7], "local": 2, "viewabl": 2, "html": [2, 8], "index": [2, 14, 17, 18], "trello": 2, "banlist": [2, 3, 14, 16], "biasgroup": [2, 3, 14, 16], "globalset": [2, 3, 14, 16], "idstor": [2, 3, 14], "imagepreset": [2, 3, 15, 16, 17], "keystor": [2, 3, 14, 16, 17, 18, 19], "novelaierror": [2, 3, 16], "preset": [2, 3, 4, 5, 6, 8, 14, 15, 16, 17, 18, 19], "schemavalid": [2, 3], "storyhandl": [2, 3], "util": [2, 3, 9, 16], "low_level": [3, 8, 11], "print_with_paramet": [3, 17], "lowlevel": [3, 11, 17], "high_level": [3, 11], "highlevel": [3, 11, 16], "imagemodel": [3, 8, 15, 16, 17], "controlnetmodel": [3, 8, 17], "imageresolut": [3, 8], "imagesampl": [3, 8, 17], "ucpreset": [3, 8], "imagegenerationtyp": [3, 8, 16, 17], "order": [3, 12], "enum_contain": [3, 12], "collapse_model": [3, 12], "strenum": [3, 12], "preambl": [3, 12], "presetview": [3, 12], "novelaistori": [3, 14], "novelaistorystorag": [3, 14], "token": [3, 4, 5, 6, 12, 16, 17, 18], "sentencepiec": [3, 15], "argon_hash": [3, 18], "get_encryption_kei": [3, 9, 18], "decrypt_data": [3, 18], "encrypt_data": [3, 18], "decompress_user_data": [3, 18], "compress_user_data": [3, 18], "decrypt_user_data": [3, 16, 18], "encrypt_user_data": [3, 16, 18], "link_content_to_stori": [3, 18], "unlink_content_from_stori": [3, 18], "get_decrypted_user_data": [3, 18], "tokens_to_b64": [3, 18], "b64_to_token": [3, 16, 18], "extract_preset_data": [3, 18], "tokenize_if_not": [3, 18], "sequenc": [4, 5, 12], "union": [4, 5, 8, 11, 12, 15, 16, 17, 18], "int": [4, 5, 6, 8, 10, 12, 14, 15, 16, 17, 18, 20], "enabl": [4, 5, 8, 12, 17], "bool": [4, 5, 6, 8, 12, 14, 16, 17, 18, 20], "ban": [4, 16], "given": [4, 12, 17], "element": [4, 5], "string": [4, 5, 17, 18], "recommend": [4, 5], "flexibl": [4, 5], "between": [4, 5, 11], "paramet": [4, 5, 6, 8, 9, 11, 12, 14, 15, 16, 17, 18, 20], "add": [4, 5, 15, 20], "dict": [4, 5, 6, 8, 9, 12, 14, 15, 16, 17, 18], "get_tokenized_entri": [4, 5], "iter": [4, 5, 16, 18], "bia": [5, 16], "float": [5, 8, 11, 12, 17], "ensure_sequence_finish": 5, "fals": [5, 12, 14, 16, 17, 18, 20], "generate_onc": 5, "neg": 5, "downbia": 5, "posit": 5, "upbia": 5, "ensur": [5, 19], "complet": [5, 16, 17], "bias": [5, 6, 14, 16], "first": [5, 20], "occurr": 5, "classmethod": [5, 8, 12, 13, 15], "from_data": 5, "store": [6, 8, 12, 16], "global": [6, 16], "generate_until_sent": 6, "up": [6, 16], "20": 6, "after": [6, 20], "max_length": [6, 12], "end": [6, 14], "sentenc": 6, "found": [6, 12], "within": 6, "num_logprob": 6, "number": [6, 8, 12, 17, 20], "logprob": 6, "each": [6, 15, 16, 18, 20], "no_logprob": 6, "disabl": [6, 12, 17, 19], "ban_bracket": 6, "appli": 6, "bracket": 6, "bias_dinkus_aster": 6, "dinkus_aster": 6, "ban_ambiguous_genji_token": 6, "genji_ambiguous_token": 6, "genji": [6, 12], "rep_pen_whitelist": 6, "repetit": [6, 12], "penalti": [6, 12], "whitelist": 6, "1": [6, 8, 10, 12, 17, 19], "copi": [6, 8, 12], "new": [6, 7, 8, 9, 11, 12, 16, 17], "to_set": [6, 8, 12], "regist": [7, 16, 17], "arg": [7, 17], "id": [7, 14, 16, 17, 18], "everi": 7, "item": [7, 18], "must": [7, 16, 17, 18, 20], "retriev": [7, 16, 18], "download_user_cont": 7, "uniqu": 7, "hasn": 7, "been": [7, 16, 17, 18], "enum": [8, 12, 17], "suggest_tag": [8, 17], "generate_imag": [8, 16, 17], "anime_cur": 8, "safe": 8, "diffus": 8, "anime_ful": 8, "furri": 8, "inainting_anime_cur": 8, "inpaint": 8, "inpainting_anime_ful": 8, "inpainting_furri": 8, "controlnet_model": 8, "generate_controlnet_mask": [8, 17], "palette_swap": 8, "hed": 8, "form_lock": 8, "mida": 8, "scribbler": 8, "fake_scribbl": 8, "building_control": 8, "mlsd": 8, "landscap": 8, "uniform": 8, "resolut": 8, "small_portrait": 8, "384": 8, "640": 8, "small_landscap": 8, "small_squar": 8, "512": 8, "normal_portrait": 8, "768": 8, "normal_landscap": 8, "normal_squar": 8, "large_portrait": 8, "1024": 8, "large_landscap": 8, "large_squar": 8, "k_lm": 8, "k_euler": 8, "k_euler_ancestr": 8, "k_heun": 8, "plm": 8, "ddim": 8, "nai_smea": 8, "nai_smea_dyn": 8, "k_dpmpp_2m": 8, "k_dpmpp_2s_ancestr": 8, "k_dpmpp_sde": 8, "k_dpm_2": 8, "k_dpm_2_ancestr": 8, "k_dpm_adapt": 8, "k_dpm_fast": 8, "uc": 8, "uc_preset": 8, "preset_low_quality_bad_anatomi": 8, "0": [8, 12, 17], "preset_low_qu": 8, "preset_bad_anatomi": 8, "preset_non": 8, "3": [8, 12, 17], "normal": [8, 16], "infil": 8, "quality_toggl": 8, "doc": [8, 12], "qualitytag": 8, "tupl": [8, 16, 17, 18], "width": [8, 17], "height": [8, 17], "prepend": 8, "n_sampl": 8, "seed": [8, 17], "random": [8, 9, 12], "ith": 8, "ha": [8, 16, 17, 18], "nois": 8, "strengthnois": 8, "strength": 8, "scale": [8, 17], "stepsguid": 8, "call": [8, 16, 17, 20], "prompt": [8, 12, 16, 17], "guidanc": 8, "step": [8, 17], "undesiredcont": 8, "smea": 8, "make": [8, 11], "larg": 8, "smea_dyn": 8, "dyn": 8, "best": 8, "wallpap": 8, "controlnet_condit": [8, 17], "gotten": 8, "method": [8, 15, 16, 17, 18], "controlnet_strength": 8, "influenc": 8, "chosen": [8, 12, 15], "decrisp": 8, "reduc": 8, "deepfri": 8, "effect": 8, "twitter": 8, "com": [8, 12], "birchlab": 8, "statu": [8, 10, 17], "1582165379832348672": 8, "add_original_imag": 8, "prevent": 8, "seam": 8, "along": 8, "edg": 8, "mai": 8, "slightli": 8, "black": 8, "white": 8, "area": 8, "last_se": 8, "when": [8, 10, 12, 16], "metadata": 8, "might": 8, "hassl": 8, "updat": [8, 12], "kwarg": [8, 12, 16], "like": [8, 12], "instanc": [8, 14], "function": [8, 12, 16, 17, 20], "get": [8, 12, 15, 17], "get_max_n_sampl": 8, "allow": [8, 12, 17], "max": 8, "calculate_cost": 8, "is_opu": 8, "calcul": 8, "cost": 8, "anla": 8, "subscript": [8, 17], "tier": [8, 17], "opu": [8, 17], "free": [8, 14, 17], "so": 8, "from_fil": [8, 12], "path": [8, 12], "pathlik": [8, 12], "write": [8, 12], "read": 8, "to_fil": [8, 12], "load": [8, 14], "meta": [9, 14, 16, 17], "assign": 9, "nonc": [9, 18], "kei": [9, 12, 14, 16, 17, 18], "encrypt": [9, 16, 17, 18, 19], "comput": [9, 16], "except": 10, "rais": [10, 20], "problem": [10, 19], "occur": 10, "url": [10, 11], "messag": 10, "caus": 10, "code": 10, "wa": [10, 12, 17], "lib_root": 11, "home": 11, "runner": 11, "session": 11, "aiohttp": 11, "client": 11, "clientsess": 11, "interact": 11, "attribut": 11, "purpos": 11, "attach_sess": 11, "detach_sess": 11, "switch": 11, "synchron": 11, "asynchron": 11, "request": [11, 16, 17], "attach": 11, "empti": [11, 12], "header": 11, "multidict": 11, "_multidict": 11, "cimultidict": 11, "cooki": 11, "simplecooki": 11, "yarl": 11, "proxy_auth": 11, "basicauth": 11, "authent": 11, "_low_level": 11, "thin": 11, "wrapper": [11, 15], "_high_level": 11, "abstract": [11, 15], "top": [11, 12, 16, 17], "detach": 11, "timeout": 11, "second": [11, 18, 20], "intenum": [12, 17], "enumer": 12, "temperatur": [12, 17], "top_k": 12, "top_p": 12, "tf": 12, "top_a": 12, "4": [12, 17], "typical_p": 12, "5": [12, 20], "enum_class": 12, "enummeta": 12, "check": [12, 16, 17, 19], "collaps": 12, "multipl": [12, 16, 17], "version": [12, 17], "last": 12, "sigurd": 12, "6b": 12, "v4": 12, "euterp": [12, 14], "v2": [12, 14, 17], "krake": 12, "clio": 12, "v1": [12, 17], "jp": 12, "snek": 12, "hypebot": 12, "inlin": 12, "infillmodel": 12, "enum_member_valu": 12, "n": [12, 19], "author": 12, "variou": [12, 17], "prologu": 12, "60": 12, "198": 12, "endoftext": 12, "sent": [12, 17, 18], "officials_valu": 12, "diversity_penalti": 12, "length_penalti": 12, "40": 12, "min_length": 12, "repetition_penalti": 12, "repetition_penalty_frequ": 12, "repetition_penalty_pres": 12, "repetition_penalty_rang": 12, "repetition_penalty_slop": 12, "repetition_penalty_whitelist": 12, "stop_sequ": 12, "tail_free_sampl": 12, "textgenerationsettingsvers": 12, "naidb": 12, "mirahez": 12, "org": 12, "wiki": 12, "generation_set": 12, "randomness_": 12, "respons": [12, 17], "length": [12, 17], "interrupt": 12, "stop": 12, "minimum": 12, "k_sampl": 12, "a_sampl": 12, "nucleus_sampl": 12, "typical_sampl": 12, "arxiv": 12, "pdf": 12, "2202": 12, "00666": 12, "tail": 12, "free_sampl": 12, "1909": 12, "05858": 12, "rang": 12, "cover": 12, "platform": 12, "openai": 12, "refer": 12, "detail": 12, "exclud": 12, "color": 12, "huggingfac": 12, "co": 12, "transform": [12, 18], "main_class": 12, "pretrainedconfig": 12, "pad_token_id": 12, "text_gener": 12, "generationconfig": 12, "bos_token_id": 12, "eos_token_id": 12, "max_tim": 12, "no_repeat_ngram_s": 12, "encoder_no_repeat_ngram_s": 12, "num_return_sequ": 12, "get_hidden_st": 12, "output_hidden_st": 12, "process": 12, "noreturn": [12, 17], "instanti": 12, "from_preset_data": 12, "from_offici": [12, 19], "mean": [12, 16], "from_default": [12, 19], "obj": 13, "text_generation_settings_vers": 14, "default_model": 14, "prefix": [14, 16], "global_set": [14, 16], "storycont": [14, 16, 19], "tree": 14, "context_s": 14, "build_context": 14, "edit": 14, "start": [14, 16, 17], "undo": 14, "redo": 14, "save": 14, "upload": [14, 16, 17], "choos": 14, "flatten": 14, "delet": [14, 17], "get_current_tre": 14, "storag": [14, 17], "here": 14, "load_from_remot": 14, "select": [14, 17], "story_id": 14, "previous": 14, "ones": 14, "handler": 14, "unload": 14, "ing": 14, "novelai_storyproxi": 14, "sentencepieceprocessor": 15, "around": 15, "decod": [15, 16, 18], "model_path": 15, "trans_table_id": 15, "trans_table_str": 15, "trans_regex_str": 15, "pattern": 15, "workaround": 15, "need": [15, 17], "becaus": 15, "cannot": 15, "some": 15, "behind": 15, "get_tokenizer_nam": 15, "meant": [16, 17], "directli": [16, 17, 20], "rather": [16, 17], "parent": [16, 17], "recapcha": [16, 17], "email": [16, 17, 18], "send_mail": 16, "giftkei": [16, 17], "websit": [16, 17], "send": [16, 17], "mail": 16, "hash": [16, 17], "recoveri": [16, 17], "success": [16, 17], "access": [16, 17], "login_from_token": 16, "access_kei": [16, 17], "instead": 16, "get_keystor": [16, 17, 18], "readabl": [16, 17], "manner": 16, "map": 16, "throw": 16, "repeatedli": 16, "your": [16, 17], "internet": 16, "connect": 16, "integr": [16, 19], "lose": [16, 17], "overwrit": [16, 17], "set_keystor": [16, 17], "raw": [16, 17], "serial": [16, 17], "download_user_stori": 16, "download_user_story_cont": 16, "download_user_preset": 16, "download_user_modul": 16, "aimodul": [16, 19], "download_user_shelv": 16, "shelf": 16, "upload_user_cont": 16, "compress": [16, 18, 19], "succeed": 16, "otherwis": 16, "even": 16, "fail": 16, "bad_word": 16, "onc": 16, "finish": [16, 17], "As": [16, 17], "accept": [16, 17, 20], "go": [16, 17], "beyond": [16, 17], "truncat": [16, 17], "give": 16, "ai": [16, 17], "down": 16, "addit": 16, "generate_stream": 16, "asynciter": [16, 17], "time": [16, 18, 20], "action": [16, 17], "describ": 16, "want": 16, "pair": [16, 17], "nice": 17, "wai": 17, "download_object": 17, "stream": 17, "post": 17, "is_reach": 17, "reachabl": 17, "change_access_kei": 17, "current_kei": 17, "new_kei": 17, "new_email": 17, "send_email_verif": 17, "verif": 17, "verify_email": 17, "verification_token": 17, "get_inform": 17, "extens": 17, "inform": 17, "about": 17, "request_account_recoveri": 17, "lost": 17, "differ": 17, "recover_account": 17, "recovery_token": 17, "delete_cont": 17, "recov": 17, "delete_account": 17, "get_data": 17, "get_prior": 17, "prioriti": 17, "system": 17, "legaci": 17, "isn": 17, "realli": 17, "import": 17, "subscriptionti": 17, "paper": 17, "trial": 17, "tablet": 17, "scroll": 17, "get_subscript": 17, "equal": 17, "object_typ": 17, "upload_object": 17, "link": [17, 18], "object_id": 17, "delete_object": 17, "get_set": 17, "format": 17, "arbitrari": 17, "set_set": 17, "bind_subscript": 17, "payment_processor": 17, "subscription_id": 17, "bind": 17, "payment": 17, "renew": 17, "monthli": 17, "change_subscript": 17, "new_plan": 17, "still": 17, "bound": 17, "param": 17, "generate_prompt": 17, "temp": 17, "upscale_imag": 17, "afaik": 17, "factor": 17, "final": 17, "classifi": 17, "Not": 17, "certain": 17, "confid": 17, "consid": 17, "much": 17, "dataset": 17, "other": [17, 19], "similar": 17, "generate_voic": 17, "synthes": 17, "side": 17, "webm": 17, "mp3": 17, "train_modul": 17, "rate": 17, "desc": 17, "train": 17, "singl": 17, "learn": 17, "descript": 17, "being": 17, "get_trained_modul": 17, "module_id": 17, "delete_modul": 17, "got": 17, "buy_step": 17, "amount": 17, "size": 18, "domain": 18, "is_compress": 18, "ref": 18, "doesn": 18, "utf8": 18, "translat": 18, "won": 18, "story_cont": 18, "remov": 18, "filter": 18, "out": 18, "base64": 18, "For": 19, "under": 19, "specif": 19, "pytest": [19, 20], "scheme": 19, "keystore_integr": 19, "verifi": 19, "stories_integr": 19, "storycontent_integr": 19, "presets_integr": 19, "aimodules_integr": 19, "shelves_integr": 19, "sync": [19, 20], "capabl": 19, "without": [19, 20], "right": 19, "job": 19, "pertain": 19, "test_preset": 19, "preset_from_default": 19, "preset_from_offici": 19, "automodul": 19, "member": 19, "error_handl": [19, 20], "api_handl": [19, 20], "api_handle_sync": [19, 20], "func_ext": 20, "callabl": 20, "await": 20, "attempt": 20, "wait": 20, "decor": 20, "argument": 20, "substitut": 20, "func": 20, "fixtur": 20}, "objects": {"example": [[1, 0, 0, "-", "boilerplate"], [0, 0, 0, "-", "download_modules"], [0, 0, 0, "-", "download_presets"], [0, 0, 0, "-", "download_shelves"], [0, 0, 0, "-", "download_stories_and_content"], [0, 0, 0, "-", "generate_controlnet_masks"], [0, 0, 0, "-", "generate_image"], [0, 0, 0, "-", "generate_image_test_samplers"], [0, 0, 0, "-", "generate_image_with_controlnet"], [0, 0, 0, "-", "generate_image_with_img2img"], [0, 0, 0, "-", "generate_text"], [0, 0, 0, "-", "generate_voice"], [0, 0, 0, "-", "login"], [0, 0, 0, "-", "login_with_proxy"], [0, 0, 0, "-", "suggest_tags"], [0, 0, 0, "-", "upscale_image"]], "example.boilerplate": [[1, 1, 1, "", "API"], [1, 1, 1, "", "JSONEncoder"], [1, 5, 1, "", "dumps"]], "example.boilerplate.API": [[1, 2, 1, "", "__init__"], [1, 3, 1, "", "api"], [1, 4, 1, "", "encryption_key"], [1, 3, 1, "", "logger"]], "example.boilerplate.JSONEncoder": [[1, 2, 1, "", "default"]], "novelai_api": [[4, 0, 0, "-", "BanList"], [5, 0, 0, "-", "BiasGroup"], [6, 0, 0, "-", "GlobalSettings"], [7, 0, 0, "-", "Idstore"], [8, 0, 0, "-", "ImagePreset"], [9, 0, 0, "-", "Keystore"], [10, 0, 0, "-", "NovelAIError"], [11, 0, 0, "-", "NovelAI_API"], [12, 0, 0, "-", "Preset"], [13, 0, 0, "-", "SchemaValidator"], [14, 0, 0, "-", "StoryHandler"], [15, 0, 0, "-", "Tokenizer"], [16, 0, 0, "-", "_high_level"], [17, 0, 0, "-", "_low_level"], [18, 0, 0, "-", "utils"]], "novelai_api.BanList": [[4, 1, 1, "", "BanList"]], "novelai_api.BanList.BanList": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "add"], [4, 3, 1, "", "enabled"], [4, 2, 1, "", "get_tokenized_entries"]], "novelai_api.BiasGroup": [[5, 1, 1, "", "BiasGroup"]], "novelai_api.BiasGroup.BiasGroup": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "add"], [5, 3, 1, "", "bias"], [5, 3, 1, "", "enabled"], [5, 3, 1, "", "ensure_sequence_finish"], [5, 2, 1, "", "from_data"], [5, 3, 1, "", "generate_once"], [5, 2, 1, "", "get_tokenized_entries"]], "novelai_api.GlobalSettings": [[6, 1, 1, "", "GlobalSettings"]], "novelai_api.GlobalSettings.GlobalSettings": [[6, 3, 1, "", "NO_LOGPROBS"], [6, 2, 1, "", "__init__"], [6, 3, 1, "", "ban_ambiguous_genji_tokens"], [6, 3, 1, "", "ban_brackets"], [6, 3, 1, "", "bias_dinkus_asterism"], [6, 2, 1, "", "copy"], [6, 3, 1, "", "generate_until_sentence"], [6, 3, 1, "", "num_logprobs"], [6, 3, 1, "", "rep_pen_whitelist"], [6, 2, 1, "", "to_settings"]], "novelai_api.Idstore": [[7, 1, 1, "", "Idstore"]], "novelai_api.Idstore.Idstore": [[7, 2, 1, "", "__init__"], [7, 2, 1, "", "create"], [7, 2, 1, "", "register"]], "novelai_api.ImagePreset": [[8, 1, 1, "", "ControlNetModel"], [8, 1, 1, "", "ImageGenerationType"], [8, 1, 1, "", "ImageModel"], [8, 1, 1, "", "ImagePreset"], [8, 1, 1, "", "ImageResolution"], [8, 1, 1, "", "ImageSampler"], [8, 1, 1, "", "UCPreset"]], "novelai_api.ImagePreset.ControlNetModel": [[8, 3, 1, "", "Building_Control"], [8, 3, 1, "", "Form_Lock"], [8, 3, 1, "", "Landscaper"], [8, 3, 1, "", "Palette_Swap"], [8, 3, 1, "", "Scribbler"]], "novelai_api.ImagePreset.ImageGenerationType": [[8, 3, 1, "", "IMG2IMG"], [8, 3, 1, "", "INPAINTING"], [8, 3, 1, "", "NORMAL"]], "novelai_api.ImagePreset.ImageModel": [[8, 3, 1, "", "Anime_Curated"], [8, 3, 1, "", "Anime_Full"], [8, 3, 1, "", "Furry"], [8, 3, 1, "", "Inainting_Anime_Curated"], [8, 3, 1, "", "Inpainting_Anime_Full"], [8, 3, 1, "", "Inpainting_Furry"]], "novelai_api.ImagePreset.ImagePreset": [[8, 2, 1, "", "__init__"], [8, 3, 1, "", "add_original_image"], [8, 2, 1, "", "calculate_cost"], [8, 3, 1, "", "controlnet_condition"], [8, 3, 1, "", "controlnet_model"], [8, 3, 1, "", "controlnet_strength"], [8, 2, 1, "", "copy"], [8, 3, 1, "", "decrisper"], [8, 2, 1, "", "from_file"], [8, 2, 1, "", "get_max_n_samples"], [8, 3, 1, "", "image"], [8, 3, 1, "", "last_seed"], [8, 3, 1, "", "mask"], [8, 3, 1, "", "n_samples"], [8, 3, 1, "", "noise"], [8, 3, 1, "", "quality_toggle"], [8, 3, 1, "", "resolution"], [8, 3, 1, "", "sampler"], [8, 3, 1, "", "scale"], [8, 3, 1, "", "seed"], [8, 3, 1, "", "smea"], [8, 3, 1, "", "smea_dyn"], [8, 3, 1, "", "steps"], [8, 3, 1, "", "strength"], [8, 2, 1, "", "to_file"], [8, 2, 1, "", "to_settings"], [8, 3, 1, "", "uc"], [8, 3, 1, "", "uc_preset"], [8, 2, 1, "", "update"]], "novelai_api.ImagePreset.ImageResolution": [[8, 3, 1, "", "Large_Landscape"], [8, 3, 1, "", "Large_Portrait"], [8, 3, 1, "", "Large_Square"], [8, 3, 1, "", "Normal_Landscape"], [8, 3, 1, "", "Normal_Portrait"], [8, 3, 1, "", "Normal_Square"], [8, 3, 1, "", "Small_Landscape"], [8, 3, 1, "", "Small_Portrait"], [8, 3, 1, "", "Small_Square"]], "novelai_api.ImagePreset.ImageSampler": [[8, 3, 1, "", "ddim"], [8, 3, 1, "", "k_dpm_2"], [8, 3, 1, "", "k_dpm_2_ancestral"], [8, 3, 1, "", "k_dpm_adaptive"], [8, 3, 1, "", "k_dpm_fast"], [8, 3, 1, "", "k_dpmpp_2m"], [8, 3, 1, "", "k_dpmpp_2s_ancestral"], [8, 3, 1, "", "k_dpmpp_sde"], [8, 3, 1, "", "k_euler"], [8, 3, 1, "", "k_euler_ancestral"], [8, 3, 1, "", "k_heun"], [8, 3, 1, "", "k_lms"], [8, 3, 1, "", "nai_smea"], [8, 3, 1, "", "nai_smea_dyn"], [8, 3, 1, "", "plms"]], "novelai_api.ImagePreset.UCPreset": [[8, 3, 1, "", "Preset_Bad_Anatomy"], [8, 3, 1, "", "Preset_Low_Quality"], [8, 3, 1, "", "Preset_Low_Quality_Bad_Anatomy"], [8, 3, 1, "", "Preset_None"]], "novelai_api.Keystore": [[9, 1, 1, "", "Keystore"]], "novelai_api.Keystore.Keystore": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "create"], [9, 3, 1, "", "data"], [9, 2, 1, "", "decrypt"], [9, 2, 1, "", "encrypt"]], "novelai_api.NovelAIError": [[10, 6, 1, "", "NovelAIError"]], "novelai_api.NovelAIError.NovelAIError": [[10, 2, 1, "", "__init__"], [10, 3, 1, "", "message"], [10, 3, 1, "", "status"], [10, 3, 1, "", "url"]], "novelai_api.NovelAI_API": [[11, 1, 1, "", "NovelAIAPI"]], "novelai_api.NovelAI_API.NovelAIAPI": [[11, 3, 1, "", "BASE_ADDRESS"], [11, 3, 1, "", "LIB_ROOT"], [11, 2, 1, "", "__init__"], [11, 2, 1, "", "attach_session"], [11, 3, 1, "", "cookies"], [11, 2, 1, "", "detach_session"], [11, 3, 1, "", "headers"], [11, 3, 1, "", "high_level"], [11, 3, 1, "", "logger"], [11, 3, 1, "", "low_level"], [11, 3, 1, "", "proxy"], [11, 3, 1, "", "proxy_auth"], [11, 3, 1, "", "session"], [11, 4, 1, "", "timeout"]], "novelai_api.Preset": [[12, 1, 1, "", "Model"], [12, 1, 1, "", "Order"], [12, 7, 1, "", "PREAMBLE"], [12, 1, 1, "", "Preset"], [12, 1, 1, "", "PresetView"], [12, 1, 1, "", "StrEnum"], [12, 5, 1, "", "collapse_model"], [12, 5, 1, "", "enum_contains"]], "novelai_api.Preset.Model": [[12, 3, 1, "", "Clio"], [12, 3, 1, "", "Euterpe"], [12, 3, 1, "", "Genji"], [12, 3, 1, "", "HypeBot"], [12, 3, 1, "", "Inline"], [12, 3, 1, "", "Krake"], [12, 3, 1, "", "Sigurd"], [12, 3, 1, "", "Snek"], [12, 3, 1, "", "enum_member_values"]], "novelai_api.Preset.Order": [[12, 3, 1, "", "TFS"], [12, 3, 1, "", "Temperature"], [12, 3, 1, "", "Top_A"], [12, 3, 1, "", "Top_K"], [12, 3, 1, "", "Top_P"], [12, 3, 1, "", "Typical_P"]], "novelai_api.Preset.Preset": [[12, 3, 1, "", "DEFAULTS"], [12, 2, 1, "", "__init__"], [12, 3, 1, "", "bos_token_id"], [12, 2, 1, "", "copy"], [12, 3, 1, "", "diversity_penalty"], [12, 2, 1, "", "enable"], [12, 3, 1, "", "encoder_no_repeat_ngram_size"], [12, 3, 1, "", "eos_token_id"], [12, 2, 1, "", "from_default"], [12, 2, 1, "", "from_file"], [12, 2, 1, "", "from_official"], [12, 2, 1, "", "from_preset_data"], [12, 3, 1, "", "get_hidden_states"], [12, 3, 1, "", "length_penalty"], [12, 3, 1, "", "max_length"], [12, 3, 1, "", "max_time"], [12, 3, 1, "", "min_length"], [12, 3, 1, "", "model"], [12, 3, 1, "", "name"], [12, 3, 1, "", "no_repeat_ngram_size"], [12, 3, 1, "", "num_return_sequences"], [12, 3, 1, "", "order"], [12, 3, 1, "", "pad_token_id"], [12, 3, 1, "", "repetition_penalty"], [12, 3, 1, "", "repetition_penalty_frequency"], [12, 3, 1, "", "repetition_penalty_presence"], [12, 3, 1, "", "repetition_penalty_range"], [12, 3, 1, "", "repetition_penalty_slope"], [12, 3, 1, "", "repetition_penalty_whitelist"], [12, 2, 1, "", "set"], [12, 3, 1, "", "tail_free_sampling"], [12, 3, 1, "", "temperature"], [12, 3, 1, "", "textGenerationSettingsVersion"], [12, 2, 1, "", "to_file"], [12, 2, 1, "", "to_settings"], [12, 3, 1, "", "top_a"], [12, 3, 1, "", "top_k"], [12, 3, 1, "", "top_p"], [12, 3, 1, "", "typical_p"], [12, 2, 1, "", "update"]], "novelai_api.Preset.PresetView": [[12, 2, 1, "", "__init__"], [12, 3, 1, "", "model"]], "novelai_api.SchemaValidator": [[13, 1, 1, "", "SchemaValidator"]], "novelai_api.SchemaValidator.SchemaValidator": [[13, 2, 1, "", "__init__"], [13, 2, 1, "", "validate"]], "novelai_api.StoryHandler": [[14, 1, 1, "", "NovelAIStory"], [14, 1, 1, "", "NovelAIStoryStorage"]], "novelai_api.StoryHandler.NovelAIStory": [[14, 3, 1, "", "DEFAULT_MODEL"], [14, 3, 1, "", "TEXT_GENERATION_SETTINGS_VERSION"], [14, 2, 1, "", "__init__"], [14, 3, 1, "", "api"], [14, 3, 1, "", "banlists"], [14, 3, 1, "", "biases"], [14, 2, 1, "", "build_context"], [14, 2, 1, "", "choose"], [14, 3, 1, "", "context_size"], [14, 2, 1, "", "delete"], [14, 2, 1, "", "edit"], [14, 2, 1, "", "flatten"], [14, 2, 1, "", "generate"], [14, 2, 1, "", "get_current_tree"], [14, 3, 1, "", "global_settings"], [14, 3, 1, "", "key"], [14, 3, 1, "", "keystore"], [14, 3, 1, "", "model"], [14, 3, 1, "", "prefix"], [14, 3, 1, "", "preset"], [14, 2, 1, "", "redo"], [14, 2, 1, "", "save"], [14, 3, 1, "", "story"], [14, 3, 1, "", "storycontent"], [14, 3, 1, "", "tree"], [14, 2, 1, "", "undo"]], "novelai_api.StoryHandler.NovelAIStoryStorage": [[14, 2, 1, "", "__init__"], [14, 3, 1, "", "api"], [14, 2, 1, "", "create"], [14, 3, 1, "", "global_settings"], [14, 3, 1, "", "idstore"], [14, 3, 1, "", "keystore"], [14, 2, 1, "", "load"], [14, 2, 1, "", "load_from_remote"], [14, 2, 1, "", "loads"], [14, 2, 1, "", "select"], [14, 2, 1, "", "unload"]], "novelai_api.Tokenizer": [[15, 1, 1, "", "SentencePiece"], [15, 1, 1, "", "Tokenizer"]], "novelai_api.Tokenizer.SentencePiece": [[15, 2, 1, "", "__init__"], [15, 2, 1, "", "decode"], [15, 2, 1, "", "encode"], [15, 3, 1, "", "trans_regex_str"], [15, 3, 1, "", "trans_table_ids"], [15, 3, 1, "", "trans_table_str"]], "novelai_api.Tokenizer.Tokenizer": [[15, 2, 1, "", "decode"], [15, 2, 1, "", "encode"], [15, 2, 1, "", "get_tokenizer_name"]], "novelai_api._high_level": [[16, 1, 1, "", "HighLevel"]], "novelai_api._high_level.HighLevel": [[16, 2, 1, "", "__init__"], [16, 2, 1, "", "download_user_modules"], [16, 2, 1, "", "download_user_presets"], [16, 2, 1, "", "download_user_shelves"], [16, 2, 1, "", "download_user_stories"], [16, 2, 1, "", "download_user_story_contents"], [16, 2, 1, "", "generate"], [16, 2, 1, "", "generate_image"], [16, 2, 1, "", "generate_stream"], [16, 2, 1, "", "get_keystore"], [16, 2, 1, "", "login"], [16, 2, 1, "", "login_from_token"], [16, 2, 1, "", "register"], [16, 2, 1, "", "set_keystore"], [16, 2, 1, "", "upload_user_content"], [16, 2, 1, "", "upload_user_contents"]], "novelai_api._low_level": [[17, 1, 1, "", "LowLevel"], [17, 5, 1, "", "print_with_parameters"]], "novelai_api._low_level.LowLevel": [[17, 1, 1, "", "SubscriptionTier"], [17, 2, 1, "", "__init__"], [17, 2, 1, "", "bind_subscription"], [17, 2, 1, "", "buy_steps"], [17, 2, 1, "", "change_access_key"], [17, 2, 1, "", "change_subscription"], [17, 2, 1, "", "classify"], [17, 2, 1, "", "delete_account"], [17, 2, 1, "", "delete_module"], [17, 2, 1, "", "delete_object"], [17, 2, 1, "", "download_object"], [17, 2, 1, "", "download_objects"], [17, 2, 1, "", "generate"], [17, 2, 1, "", "generate_controlnet_mask"], [17, 2, 1, "", "generate_image"], [17, 2, 1, "", "generate_prompt"], [17, 2, 1, "", "generate_voice"], [17, 2, 1, "", "get_data"], [17, 2, 1, "", "get_information"], [17, 2, 1, "", "get_keystore"], [17, 2, 1, "", "get_priority"], [17, 2, 1, "", "get_settings"], [17, 2, 1, "", "get_subscription"], [17, 2, 1, "", "get_trained_module"], [17, 2, 1, "", "get_trained_modules"], [17, 2, 1, "", "is_reachable"], [17, 3, 1, "", "is_schema_validation_enabled"], [17, 2, 1, "", "login"], [17, 2, 1, "", "recover_account"], [17, 2, 1, "", "register"], [17, 2, 1, "", "request"], [17, 2, 1, "", "request_account_recovery"], [17, 2, 1, "", "send_email_verification"], [17, 2, 1, "", "set_keystore"], [17, 2, 1, "", "set_settings"], [17, 2, 1, "", "suggest_tags"], [17, 2, 1, "", "train_module"], [17, 2, 1, "", "upload_object"], [17, 2, 1, "", "upload_objects"], [17, 2, 1, "", "upscale_image"], [17, 2, 1, "", "verify_email"]], "novelai_api._low_level.LowLevel.SubscriptionTier": [[17, 3, 1, "", "OPUS"], [17, 3, 1, "", "PAPER"], [17, 3, 1, "", "SCROLL"], [17, 3, 1, "", "TABLET"]], "novelai_api.utils": [[18, 5, 1, "", "argon_hash"], [18, 5, 1, "", "b64_to_tokens"], [18, 5, 1, "", "compress_user_data"], [18, 5, 1, "", "decompress_user_data"], [18, 5, 1, "", "decrypt_data"], [18, 5, 1, "", "decrypt_user_data"], [18, 5, 1, "", "encrypt_data"], [18, 5, 1, "", "encrypt_user_data"], [18, 5, 1, "", "extract_preset_data"], [18, 5, 1, "", "get_access_key"], [18, 5, 1, "", "get_decrypted_user_data"], [18, 5, 1, "", "get_encryption_key"], [18, 5, 1, "", "link_content_to_story"], [18, 5, 1, "", "tokenize_if_not"], [18, 5, 1, "", "tokens_to_b64"], [18, 5, 1, "", "unlink_content_from_story"]], "tests.api": [[20, 0, 0, "-", "boilerplate"], [19, 0, 0, "-", "test_decrypt_encrypt_integrity_check"], [19, 0, 0, "-", "test_imagegen_samplers"], [19, 0, 0, "-", "test_sync_gen"], [19, 0, 0, "-", "test_textgen_presets"]], "tests.api.boilerplate": [[20, 1, 1, "", "API"], [20, 1, 1, "", "JSONEncoder"], [20, 5, 1, "", "api_handle"], [20, 5, 1, "", "api_handle_sync"], [20, 5, 1, "", "dumps"], [20, 5, 1, "", "error_handler"]], "tests.api.boilerplate.API": [[20, 2, 1, "", "__init__"], [20, 3, 1, "", "api"], [20, 4, 1, "", "encryption_key"], [20, 3, 1, "", "logger"]], "tests.api.boilerplate.JSONEncoder": [[20, 2, 1, "", "default"]], "tests.api.test_decrypt_encrypt_integrity_check": [[19, 5, 1, "", "aimodules_integrity"], [19, 5, 1, "", "keystore_integrity"], [19, 5, 1, "", "presets_integrity"], [19, 5, 1, "", "shelves_integrity"], [19, 5, 1, "", "stories_integrity"], [19, 5, 1, "", "storycontent_integrity"]], "tests.api.test_textgen_presets": [[19, 5, 1, "", "preset_from_default"], [19, 5, 1, "", "preset_from_official"], [19, 5, 1, "", "test_presets"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:property", "5": "py:function", "6": "py:exception", "7": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"], "6": ["py", "exception", "Python exception"], "7": ["py", "data", "Python data"]}, "titleterms": {"exampl": [0, 2], "directori": [0, 19, 21], "requir": [0, 19], "usag": [0, 2, 19], "content": [0, 19, 21], "download_modul": 0, "py": [0, 19], "download_preset": 0, "download_shelv": 0, "download_stories_and_cont": 0, "generate_controlnet_mask": 0, "generate_imag": 0, "generate_image_test_sampl": 0, "generate_image_with_controlnet": 0, "generate_image_with_img2img": 0, "generate_text": 0, "generate_voic": 0, "login": 0, "login_with_proxi": 0, "suggest_tag": 0, "upscale_imag": 0, "refer": [0, 2, 19, 21], "boilerpl": [1, 20], "novelai": [2, 3], "api": [2, 3, 19], "us": 2, "modul": 2, "via": 2, "command": 2, "line": 2, "get": 2, "access": 2, "kei": 2, "token": [2, 15], "saniti": 2, "check": 2, "decod": 2, "your": 2, "code": 2, "low_level": [2, 17], "high_level": [2, 16], "develop": 2, "contribut": 2, "test": 2, "against": 2, "mock": [2, 21], "doc": 2, "todo": 2, "packag": 3, "novelai_api": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "banlist": 4, "biasgroup": 5, "globalset": 6, "idstor": 7, "imagepreset": 8, "keystor": 9, "novelaierror": 10, "preset": 12, "schemavalid": 13, "storyhandl": 14, "util": 18, "test_decrypt_encrypt_integrity_check": 19, "test_imagegen_sampl": 19, "test_sync_gen": 19, "test_textgen_preset": 19, "test_textgen_san": 19}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx_last_updated_by_git": 1, "sphinx": 57}, "alltitles": {"example directory": [[0, "example-directory"]], "Requirements": [[0, "requirements"], [19, "requirements"]], "Usage": [[0, "usage"], [2, "usage"], [19, "usage"]], "Content": [[0, "module-example.download_modules"], [19, "content"], [21, "content"]], "download_modules.py": [[0, "download-modules-py"]], "download_presets.py": [[0, "download-presets-py"]], "download_shelves.py": [[0, "download-shelves-py"]], "download_stories_and_content.py": [[0, "download-stories-and-content-py"]], "generate_controlnet_masks.py": [[0, "generate-controlnet-masks-py"]], "generate_image.py": [[0, "generate-image-py"]], "generate_image_test_samplers.py": [[0, "generate-image-test-samplers-py"]], "generate_image_with_controlnet.py": [[0, "generate-image-with-controlnet-py"]], "generate_image_with_img2img.py": [[0, "generate-image-with-img2img-py"]], "generate_text.py": [[0, "generate-text-py"]], "generate_voice.py": [[0, "generate-voice-py"]], "login.py": [[0, "login-py"]], "login_with_proxy.py": [[0, "login-with-proxy-py"]], "suggest_tags.py": [[0, "suggest-tags-py"]], "upscale_image.py": [[0, "upscale-image-py"]], "Reference": [[0, "reference"], [2, "reference"], [19, "reference"], [21, "reference"]], "boilerplate": [[1, "module-example.boilerplate"], [20, "module-tests.api.boilerplate"]], "novelai-api": [[2, "novelai-api"], [2, "novelai-api"]], "Using the module via Command Line": [[2, "using-the-module-via-command-line"]], "Get access key": [[2, "get-access-key"]], "Get access token": [[2, "get-access-token"]], "Sanity check": [[2, "sanity-check"]], "Decode": [[2, "decode"]], "Using the module in your code": [[2, "using-the-module-in-your-code"]], "low_level": [[2, "low-level"]], "high_level": [[2, "high-level"]], "Development": [[2, "development"]], "Contributing": [[2, "contributing"]], "Testing against the API": [[2, "testing-against-the-api"]], "Testing against the mocked API": [[2, "testing-against-the-mocked-api"]], "Docs": [[2, "docs"]], "TODO": [[2, "todo"]], "example": [[2, "example"]], "Test API": [[2, "test-api"]], "Test Mocked API": [[2, "test-mocked-api"]], "novelai-api package": [[3, "novelai-api-package"]], "novelai_api.BanList": [[4, "module-novelai_api.BanList"]], "novelai_api.BiasGroup": [[5, "module-novelai_api.BiasGroup"]], "novelai_api.GlobalSettings": [[6, "module-novelai_api.GlobalSettings"]], "novelai_api.Idstore": [[7, "module-novelai_api.Idstore"]], "novelai_api.ImagePreset": [[8, "module-novelai_api.ImagePreset"]], "novelai_api.Keystore": [[9, "module-novelai_api.Keystore"]], "novelai_api.NovelAIError": [[10, "module-novelai_api.NovelAIError"]], "novelai_api.NovelAI_API": [[11, "module-novelai_api.NovelAI_API"]], "novelai_api.Preset": [[12, "module-novelai_api.Preset"]], "novelai_api.SchemaValidator": [[13, "module-novelai_api.SchemaValidator"]], "novelai_api.StoryHandler": [[14, "module-novelai_api.StoryHandler"]], "novelai_api.Tokenizer": [[15, "module-novelai_api.Tokenizer"]], "novelai_api.high_level": [[16, "module-novelai_api._high_level"]], "novelai_api.low_level": [[17, "module-novelai_api._low_level"]], "novelai_api.utils": [[18, "module-novelai_api.utils"]], "API directory": [[19, "api-directory"]], "test_decrypt_encrypt_integrity_check.py": [[19, "module-tests.api.test_decrypt_encrypt_integrity_check"]], "test_imagegen_samplers.py": [[19, "module-tests.api.test_imagegen_samplers"]], "test_sync_gen.py": [[19, "module-tests.api.test_sync_gen"]], "test_textgen_presets.py": [[19, "module-tests.api.test_textgen_presets"]], "test_textgen_sanity.py": [[19, "test-textgen-sanity-py"]], "Mock directory": [[21, "mock-directory"]]}, "indexentries": {"example.download_modules": [[0, "module-example.download_modules"]], "example.download_presets": [[0, "module-example.download_presets"]], "example.download_shelves": [[0, "module-example.download_shelves"]], "example.download_stories_and_content": [[0, "module-example.download_stories_and_content"]], "example.generate_controlnet_masks": [[0, "module-example.generate_controlnet_masks"]], "example.generate_image": [[0, "module-example.generate_image"]], "example.generate_image_test_samplers": [[0, "module-example.generate_image_test_samplers"]], "example.generate_image_with_controlnet": [[0, "module-example.generate_image_with_controlnet"]], "example.generate_image_with_img2img": [[0, "module-example.generate_image_with_img2img"]], "example.generate_text": [[0, "module-example.generate_text"]], "example.generate_voice": [[0, "module-example.generate_voice"]], "example.login": [[0, "module-example.login"]], "example.login_with_proxy": [[0, "module-example.login_with_proxy"]], "example.suggest_tags": [[0, "module-example.suggest_tags"]], "example.upscale_image": [[0, "module-example.upscale_image"]], "module": [[0, "module-example.download_modules"], [0, "module-example.download_presets"], [0, "module-example.download_shelves"], [0, "module-example.download_stories_and_content"], [0, "module-example.generate_controlnet_masks"], [0, "module-example.generate_image"], [0, "module-example.generate_image_test_samplers"], [0, "module-example.generate_image_with_controlnet"], [0, "module-example.generate_image_with_img2img"], [0, "module-example.generate_text"], [0, "module-example.generate_voice"], [0, "module-example.login"], [0, "module-example.login_with_proxy"], [0, "module-example.suggest_tags"], [0, "module-example.upscale_image"], [1, "module-example.boilerplate"], [4, "module-novelai_api.BanList"], [5, "module-novelai_api.BiasGroup"], [6, "module-novelai_api.GlobalSettings"], [7, "module-novelai_api.Idstore"], [8, "module-novelai_api.ImagePreset"], [9, "module-novelai_api.Keystore"], [10, "module-novelai_api.NovelAIError"], [11, "module-novelai_api.NovelAI_API"], [12, "module-novelai_api.Preset"], [13, "module-novelai_api.SchemaValidator"], [14, "module-novelai_api.StoryHandler"], [15, "module-novelai_api.Tokenizer"], [16, "module-novelai_api._high_level"], [17, "module-novelai_api._low_level"], [18, "module-novelai_api.utils"], [19, "module-tests.api.test_decrypt_encrypt_integrity_check"], [19, "module-tests.api.test_imagegen_samplers"], [19, "module-tests.api.test_sync_gen"], [19, "module-tests.api.test_textgen_presets"], [20, "module-tests.api.boilerplate"]], "api (class in example.boilerplate)": [[1, "example.boilerplate.API"]], "jsonencoder (class in example.boilerplate)": [[1, "example.boilerplate.JSONEncoder"]], "__init__() (api method)": [[1, "example.boilerplate.API.__init__"], [20, "tests.api.boilerplate.API.__init__"]], "api (api attribute)": [[1, "example.boilerplate.API.api"], [20, "tests.api.boilerplate.API.api"]], "default() (jsonencoder method)": [[1, "example.boilerplate.JSONEncoder.default"], [20, "tests.api.boilerplate.JSONEncoder.default"]], "dumps() (in module example.boilerplate)": [[1, "example.boilerplate.dumps"]], "encryption_key (api property)": [[1, "example.boilerplate.API.encryption_key"], [20, "tests.api.boilerplate.API.encryption_key"]], "example.boilerplate": [[1, "module-example.boilerplate"]], "logger (api attribute)": [[1, "example.boilerplate.API.logger"], [20, "tests.api.boilerplate.API.logger"]], "banlist (class in novelai_api.banlist)": [[4, "novelai_api.BanList.BanList"]], "__init__() (banlist method)": [[4, "novelai_api.BanList.BanList.__init__"]], "add() (banlist method)": [[4, "novelai_api.BanList.BanList.add"]], "enabled (banlist attribute)": [[4, "novelai_api.BanList.BanList.enabled"]], "get_tokenized_entries() (banlist method)": [[4, "novelai_api.BanList.BanList.get_tokenized_entries"]], "novelai_api.banlist": [[4, "module-novelai_api.BanList"]], "biasgroup (class in novelai_api.biasgroup)": [[5, "novelai_api.BiasGroup.BiasGroup"]], "__init__() (biasgroup method)": [[5, "novelai_api.BiasGroup.BiasGroup.__init__"]], "add() (biasgroup method)": [[5, "novelai_api.BiasGroup.BiasGroup.add"]], "bias (biasgroup attribute)": [[5, "novelai_api.BiasGroup.BiasGroup.bias"]], "enabled (biasgroup attribute)": [[5, "novelai_api.BiasGroup.BiasGroup.enabled"]], "ensure_sequence_finish (biasgroup attribute)": [[5, "novelai_api.BiasGroup.BiasGroup.ensure_sequence_finish"]], "from_data() (biasgroup class method)": [[5, "novelai_api.BiasGroup.BiasGroup.from_data"]], "generate_once (biasgroup attribute)": [[5, "novelai_api.BiasGroup.BiasGroup.generate_once"]], "get_tokenized_entries() (biasgroup method)": [[5, "novelai_api.BiasGroup.BiasGroup.get_tokenized_entries"]], "novelai_api.biasgroup": [[5, "module-novelai_api.BiasGroup"]], "globalsettings (class in novelai_api.globalsettings)": [[6, "novelai_api.GlobalSettings.GlobalSettings"]], "no_logprobs (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.NO_LOGPROBS"]], "__init__() (globalsettings method)": [[6, "novelai_api.GlobalSettings.GlobalSettings.__init__"]], "ban_ambiguous_genji_tokens (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.ban_ambiguous_genji_tokens"]], "ban_brackets (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.ban_brackets"]], "bias_dinkus_asterism (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.bias_dinkus_asterism"]], "copy() (globalsettings method)": [[6, "novelai_api.GlobalSettings.GlobalSettings.copy"]], "generate_until_sentence (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.generate_until_sentence"]], "novelai_api.globalsettings": [[6, "module-novelai_api.GlobalSettings"]], "num_logprobs (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.num_logprobs"]], "rep_pen_whitelist (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.rep_pen_whitelist"]], "to_settings() (globalsettings method)": [[6, "novelai_api.GlobalSettings.GlobalSettings.to_settings"]], "idstore (class in novelai_api.idstore)": [[7, "novelai_api.Idstore.Idstore"]], "__init__() (idstore method)": [[7, "novelai_api.Idstore.Idstore.__init__"]], "create() (idstore method)": [[7, "novelai_api.Idstore.Idstore.create"]], "novelai_api.idstore": [[7, "module-novelai_api.Idstore"]], "register() (idstore method)": [[7, "novelai_api.Idstore.Idstore.register"]], "anime_curated (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Anime_Curated"]], "anime_full (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Anime_Full"]], "building_control (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Building_Control"]], "controlnetmodel (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ControlNetModel"]], "form_lock (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Form_Lock"]], "furry (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Furry"]], "img2img (imagegenerationtype attribute)": [[8, "novelai_api.ImagePreset.ImageGenerationType.IMG2IMG"]], "inpainting (imagegenerationtype attribute)": [[8, "novelai_api.ImagePreset.ImageGenerationType.INPAINTING"]], "imagegenerationtype (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImageGenerationType"]], "imagemodel (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImageModel"]], "imagepreset (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImagePreset"]], "imageresolution (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImageResolution"]], "imagesampler (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImageSampler"]], "inainting_anime_curated (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Inainting_Anime_Curated"]], "inpainting_anime_full (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Inpainting_Anime_Full"]], "inpainting_furry (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Inpainting_Furry"]], "landscaper (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Landscaper"]], "large_landscape (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Large_Landscape"]], "large_portrait (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Large_Portrait"]], "large_square (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Large_Square"]], "normal (imagegenerationtype attribute)": [[8, "novelai_api.ImagePreset.ImageGenerationType.NORMAL"]], "normal_landscape (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Normal_Landscape"]], "normal_portrait (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Normal_Portrait"]], "normal_square (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Normal_Square"]], "palette_swap (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Palette_Swap"]], "preset_bad_anatomy (ucpreset attribute)": [[8, "novelai_api.ImagePreset.UCPreset.Preset_Bad_Anatomy"]], "preset_low_quality (ucpreset attribute)": [[8, "novelai_api.ImagePreset.UCPreset.Preset_Low_Quality"]], "preset_low_quality_bad_anatomy (ucpreset attribute)": [[8, "novelai_api.ImagePreset.UCPreset.Preset_Low_Quality_Bad_Anatomy"]], "preset_none (ucpreset attribute)": [[8, "novelai_api.ImagePreset.UCPreset.Preset_None"]], "scribbler (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Scribbler"]], "small_landscape (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Small_Landscape"]], "small_portrait (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Small_Portrait"]], "small_square (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Small_Square"]], "ucpreset (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.UCPreset"]], "__init__() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.__init__"]], "add_original_image (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.add_original_image"]], "calculate_cost() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.calculate_cost"]], "controlnet_condition (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.controlnet_condition"]], "controlnet_model (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.controlnet_model"]], "controlnet_strength (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.controlnet_strength"]], "copy() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.copy"]], "ddim (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.ddim"]], "decrisper (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.decrisper"]], "from_file() (imagepreset class method)": [[8, "novelai_api.ImagePreset.ImagePreset.from_file"]], "get_max_n_samples() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.get_max_n_samples"]], "image (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.image"]], "k_dpm_2 (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpm_2"]], "k_dpm_2_ancestral (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpm_2_ancestral"]], "k_dpm_adaptive (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpm_adaptive"]], "k_dpm_fast (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpm_fast"]], "k_dpmpp_2m (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpmpp_2m"]], "k_dpmpp_2s_ancestral (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpmpp_2s_ancestral"]], "k_dpmpp_sde (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpmpp_sde"]], "k_euler (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_euler"]], "k_euler_ancestral (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_euler_ancestral"]], "k_heun (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_heun"]], "k_lms (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_lms"]], "last_seed (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.last_seed"]], "mask (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.mask"]], "n_samples (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.n_samples"]], "nai_smea (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.nai_smea"]], "nai_smea_dyn (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.nai_smea_dyn"]], "noise (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.noise"]], "novelai_api.imagepreset": [[8, "module-novelai_api.ImagePreset"]], "plms (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.plms"]], "quality_toggle (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.quality_toggle"]], "resolution (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.resolution"]], "sampler (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.sampler"]], "scale (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.scale"]], "seed (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.seed"]], "smea (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.smea"]], "smea_dyn (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.smea_dyn"]], "steps (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.steps"]], "strength (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.strength"]], "to_file() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.to_file"]], "to_settings() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.to_settings"]], "uc (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.uc"]], "uc_preset (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.uc_preset"]], "update() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.update"]], "keystore (class in novelai_api.keystore)": [[9, "novelai_api.Keystore.Keystore"]], "__init__() (keystore method)": [[9, "novelai_api.Keystore.Keystore.__init__"]], "create() (keystore method)": [[9, "novelai_api.Keystore.Keystore.create"]], "data (keystore attribute)": [[9, "novelai_api.Keystore.Keystore.data"]], "decrypt() (keystore method)": [[9, "novelai_api.Keystore.Keystore.decrypt"]], "encrypt() (keystore method)": [[9, "novelai_api.Keystore.Keystore.encrypt"]], "novelai_api.keystore": [[9, "module-novelai_api.Keystore"]], "novelaierror": [[10, "novelai_api.NovelAIError.NovelAIError"]], "__init__() (novelaierror method)": [[10, "novelai_api.NovelAIError.NovelAIError.__init__"]], "message (novelaierror attribute)": [[10, "novelai_api.NovelAIError.NovelAIError.message"]], "novelai_api.novelaierror": [[10, "module-novelai_api.NovelAIError"]], "status (novelaierror attribute)": [[10, "novelai_api.NovelAIError.NovelAIError.status"]], "url (novelaierror attribute)": [[10, "novelai_api.NovelAIError.NovelAIError.url"]], "base_address (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.BASE_ADDRESS"]], "lib_root (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.LIB_ROOT"]], "novelaiapi (class in novelai_api.novelai_api)": [[11, "novelai_api.NovelAI_API.NovelAIAPI"]], "__init__() (novelaiapi method)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.__init__"]], "attach_session() (novelaiapi method)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.attach_session"]], "cookies (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.cookies"]], "detach_session() (novelaiapi method)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.detach_session"]], "headers (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.headers"]], "high_level (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.high_level"]], "logger (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.logger"]], "low_level (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.low_level"]], "novelai_api.novelai_api": [[11, "module-novelai_api.NovelAI_API"]], "proxy (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.proxy"]], "proxy_auth (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.proxy_auth"]], "session (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.session"]], "timeout (novelaiapi property)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.timeout"]], "clio (model attribute)": [[12, "novelai_api.Preset.Model.Clio"]], "defaults (preset attribute)": [[12, "novelai_api.Preset.Preset.DEFAULTS"]], "euterpe (model attribute)": [[12, "novelai_api.Preset.Model.Euterpe"]], "genji (model attribute)": [[12, "novelai_api.Preset.Model.Genji"]], "hypebot (model attribute)": [[12, "novelai_api.Preset.Model.HypeBot"]], "inline (model attribute)": [[12, "novelai_api.Preset.Model.Inline"]], "krake (model attribute)": [[12, "novelai_api.Preset.Model.Krake"]], "model (class in novelai_api.preset)": [[12, "novelai_api.Preset.Model"]], "order (class in novelai_api.preset)": [[12, "novelai_api.Preset.Order"]], "preamble (in module novelai_api.preset)": [[12, "novelai_api.Preset.PREAMBLE"]], "preset (class in novelai_api.preset)": [[12, "novelai_api.Preset.Preset"]], "presetview (class in novelai_api.preset)": [[12, "novelai_api.Preset.PresetView"]], "sigurd (model attribute)": [[12, "novelai_api.Preset.Model.Sigurd"]], "snek (model attribute)": [[12, "novelai_api.Preset.Model.Snek"]], "strenum (class in novelai_api.preset)": [[12, "novelai_api.Preset.StrEnum"]], "tfs (order attribute)": [[12, "novelai_api.Preset.Order.TFS"]], "temperature (order attribute)": [[12, "novelai_api.Preset.Order.Temperature"]], "top_a (order attribute)": [[12, "novelai_api.Preset.Order.Top_A"]], "top_k (order attribute)": [[12, "novelai_api.Preset.Order.Top_K"]], "top_p (order attribute)": [[12, "novelai_api.Preset.Order.Top_P"]], "typical_p (order attribute)": [[12, "novelai_api.Preset.Order.Typical_P"]], "__init__() (preset method)": [[12, "novelai_api.Preset.Preset.__init__"]], "__init__() (presetview method)": [[12, "novelai_api.Preset.PresetView.__init__"]], "bos_token_id (preset attribute)": [[12, "novelai_api.Preset.Preset.bos_token_id"]], "collapse_model() (in module novelai_api.preset)": [[12, "novelai_api.Preset.collapse_model"]], "copy() (preset method)": [[12, "novelai_api.Preset.Preset.copy"]], "diversity_penalty (preset attribute)": [[12, "novelai_api.Preset.Preset.diversity_penalty"]], "enable() (preset method)": [[12, "novelai_api.Preset.Preset.enable"]], "encoder_no_repeat_ngram_size (preset attribute)": [[12, "novelai_api.Preset.Preset.encoder_no_repeat_ngram_size"]], "enum_contains() (in module novelai_api.preset)": [[12, "novelai_api.Preset.enum_contains"]], "enum_member_values (model attribute)": [[12, "novelai_api.Preset.Model.enum_member_values"]], "eos_token_id (preset attribute)": [[12, "novelai_api.Preset.Preset.eos_token_id"]], "from_default() (preset class method)": [[12, "novelai_api.Preset.Preset.from_default"]], "from_file() (preset class method)": [[12, "novelai_api.Preset.Preset.from_file"]], "from_official() (preset class method)": [[12, "novelai_api.Preset.Preset.from_official"]], "from_preset_data() (preset class method)": [[12, "novelai_api.Preset.Preset.from_preset_data"]], "get_hidden_states (preset attribute)": [[12, "novelai_api.Preset.Preset.get_hidden_states"]], "length_penalty (preset attribute)": [[12, "novelai_api.Preset.Preset.length_penalty"]], "max_length (preset attribute)": [[12, "novelai_api.Preset.Preset.max_length"]], "max_time (preset attribute)": [[12, "novelai_api.Preset.Preset.max_time"]], "min_length (preset attribute)": [[12, "novelai_api.Preset.Preset.min_length"]], "model (preset attribute)": [[12, "novelai_api.Preset.Preset.model"]], "model (presetview attribute)": [[12, "novelai_api.Preset.PresetView.model"]], "name (preset attribute)": [[12, "novelai_api.Preset.Preset.name"]], "no_repeat_ngram_size (preset attribute)": [[12, "novelai_api.Preset.Preset.no_repeat_ngram_size"]], "novelai_api.preset": [[12, "module-novelai_api.Preset"]], "num_return_sequences (preset attribute)": [[12, "novelai_api.Preset.Preset.num_return_sequences"]], "order (preset attribute)": [[12, "novelai_api.Preset.Preset.order"]], "pad_token_id (preset attribute)": [[12, "novelai_api.Preset.Preset.pad_token_id"]], "repetition_penalty (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty"]], "repetition_penalty_frequency (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_frequency"]], "repetition_penalty_presence (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_presence"]], "repetition_penalty_range (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_range"]], "repetition_penalty_slope (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_slope"]], "repetition_penalty_whitelist (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_whitelist"]], "set() (preset method)": [[12, "novelai_api.Preset.Preset.set"]], "tail_free_sampling (preset attribute)": [[12, "novelai_api.Preset.Preset.tail_free_sampling"]], "temperature (preset attribute)": [[12, "novelai_api.Preset.Preset.temperature"]], "textgenerationsettingsversion (preset attribute)": [[12, "novelai_api.Preset.Preset.textGenerationSettingsVersion"]], "to_file() (preset method)": [[12, "novelai_api.Preset.Preset.to_file"]], "to_settings() (preset method)": [[12, "novelai_api.Preset.Preset.to_settings"]], "top_a (preset attribute)": [[12, "novelai_api.Preset.Preset.top_a"]], "top_k (preset attribute)": [[12, "novelai_api.Preset.Preset.top_k"]], "top_p (preset attribute)": [[12, "novelai_api.Preset.Preset.top_p"]], "typical_p (preset attribute)": [[12, "novelai_api.Preset.Preset.typical_p"]], "update() (preset method)": [[12, "novelai_api.Preset.Preset.update"]], "schemavalidator (class in novelai_api.schemavalidator)": [[13, "novelai_api.SchemaValidator.SchemaValidator"]], "__init__() (schemavalidator method)": [[13, "novelai_api.SchemaValidator.SchemaValidator.__init__"]], "novelai_api.schemavalidator": [[13, "module-novelai_api.SchemaValidator"]], "validate() (schemavalidator class method)": [[13, "novelai_api.SchemaValidator.SchemaValidator.validate"]], "default_model (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.DEFAULT_MODEL"]], "novelaistory (class in novelai_api.storyhandler)": [[14, "novelai_api.StoryHandler.NovelAIStory"]], "novelaistorystorage (class in novelai_api.storyhandler)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage"]], "text_generation_settings_version (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.TEXT_GENERATION_SETTINGS_VERSION"]], "__init__() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.__init__"]], "__init__() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.__init__"]], "api (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.api"]], "api (novelaistorystorage attribute)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.api"]], "banlists (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.banlists"]], "biases (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.biases"]], "build_context() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.build_context"]], "choose() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.choose"]], "context_size (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.context_size"]], "create() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.create"]], "delete() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.delete"]], "edit() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.edit"]], "flatten() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.flatten"]], "generate() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.generate"]], "get_current_tree() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.get_current_tree"]], "global_settings (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.global_settings"]], "global_settings (novelaistorystorage attribute)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.global_settings"]], "idstore (novelaistorystorage attribute)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.idstore"]], "key (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.key"]], "keystore (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.keystore"]], "keystore (novelaistorystorage attribute)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.keystore"]], "load() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.load"]], "load_from_remote() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.load_from_remote"]], "loads() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.loads"]], "model (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.model"]], "novelai_api.storyhandler": [[14, "module-novelai_api.StoryHandler"]], "prefix (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.prefix"]], "preset (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.preset"]], "redo() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.redo"]], "save() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.save"]], "select() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.select"]], "story (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.story"]], "storycontent (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.storycontent"]], "tree (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.tree"]], "undo() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.undo"]], "unload() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.unload"]], "sentencepiece (class in novelai_api.tokenizer)": [[15, "novelai_api.Tokenizer.SentencePiece"]], "tokenizer (class in novelai_api.tokenizer)": [[15, "novelai_api.Tokenizer.Tokenizer"]], "__init__() (sentencepiece method)": [[15, "novelai_api.Tokenizer.SentencePiece.__init__"]], "decode() (sentencepiece method)": [[15, "novelai_api.Tokenizer.SentencePiece.decode"]], "decode() (tokenizer class method)": [[15, "novelai_api.Tokenizer.Tokenizer.decode"]], "encode() (sentencepiece method)": [[15, "novelai_api.Tokenizer.SentencePiece.encode"]], "encode() (tokenizer class method)": [[15, "novelai_api.Tokenizer.Tokenizer.encode"]], "get_tokenizer_name() (tokenizer class method)": [[15, "novelai_api.Tokenizer.Tokenizer.get_tokenizer_name"]], "novelai_api.tokenizer": [[15, "module-novelai_api.Tokenizer"]], "trans_regex_str (sentencepiece attribute)": [[15, "novelai_api.Tokenizer.SentencePiece.trans_regex_str"]], "trans_table_ids (sentencepiece attribute)": [[15, "novelai_api.Tokenizer.SentencePiece.trans_table_ids"]], "trans_table_str (sentencepiece attribute)": [[15, "novelai_api.Tokenizer.SentencePiece.trans_table_str"]], "highlevel (class in novelai_api._high_level)": [[16, "novelai_api._high_level.HighLevel"]], "__init__() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.__init__"]], "download_user_modules() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_modules"]], "download_user_presets() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_presets"]], "download_user_shelves() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_shelves"]], "download_user_stories() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_stories"]], "download_user_story_contents() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_story_contents"]], "generate() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.generate"]], "generate_image() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.generate_image"]], "generate_stream() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.generate_stream"]], "get_keystore() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.get_keystore"]], "login() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.login"]], "login_from_token() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.login_from_token"]], "novelai_api._high_level": [[16, "module-novelai_api._high_level"]], "register() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.register"]], "set_keystore() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.set_keystore"]], "upload_user_content() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.upload_user_content"]], "upload_user_contents() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.upload_user_contents"]], "lowlevel (class in novelai_api._low_level)": [[17, "novelai_api._low_level.LowLevel"]], "lowlevel.subscriptiontier (class in novelai_api._low_level)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier"]], "opus (lowlevel.subscriptiontier attribute)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier.OPUS"]], "paper (lowlevel.subscriptiontier attribute)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier.PAPER"]], "scroll (lowlevel.subscriptiontier attribute)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier.SCROLL"]], "tablet (lowlevel.subscriptiontier attribute)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier.TABLET"]], "__init__() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.__init__"]], "bind_subscription() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.bind_subscription"]], "buy_steps() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.buy_steps"]], "change_access_key() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.change_access_key"]], "change_subscription() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.change_subscription"]], "classify() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.classify"]], "delete_account() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.delete_account"]], "delete_module() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.delete_module"]], "delete_object() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.delete_object"]], "download_object() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.download_object"]], "download_objects() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.download_objects"]], "generate() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate"]], "generate_controlnet_mask() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate_controlnet_mask"]], "generate_image() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate_image"]], "generate_prompt() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate_prompt"]], "generate_voice() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate_voice"]], "get_data() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_data"]], "get_information() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_information"]], "get_keystore() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_keystore"]], "get_priority() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_priority"]], "get_settings() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_settings"]], "get_subscription() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_subscription"]], "get_trained_module() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_trained_module"]], "get_trained_modules() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_trained_modules"]], "is_reachable() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.is_reachable"]], "is_schema_validation_enabled (lowlevel attribute)": [[17, "novelai_api._low_level.LowLevel.is_schema_validation_enabled"]], "login() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.login"]], "novelai_api._low_level": [[17, "module-novelai_api._low_level"]], "print_with_parameters() (in module novelai_api._low_level)": [[17, "novelai_api._low_level.print_with_parameters"]], "recover_account() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.recover_account"]], "register() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.register"]], "request() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.request"]], "request_account_recovery() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.request_account_recovery"]], "send_email_verification() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.send_email_verification"]], "set_keystore() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.set_keystore"]], "set_settings() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.set_settings"]], "suggest_tags() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.suggest_tags"]], "train_module() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.train_module"]], "upload_object() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.upload_object"]], "upload_objects() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.upload_objects"]], "upscale_image() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.upscale_image"]], "verify_email() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.verify_email"]], "argon_hash() (in module novelai_api.utils)": [[18, "novelai_api.utils.argon_hash"]], "b64_to_tokens() (in module novelai_api.utils)": [[18, "novelai_api.utils.b64_to_tokens"]], "compress_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.compress_user_data"]], "decompress_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.decompress_user_data"]], "decrypt_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.decrypt_data"]], "decrypt_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.decrypt_user_data"]], "encrypt_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.encrypt_data"]], "encrypt_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.encrypt_user_data"]], "extract_preset_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.extract_preset_data"]], "get_access_key() (in module novelai_api.utils)": [[18, "novelai_api.utils.get_access_key"]], "get_decrypted_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.get_decrypted_user_data"]], "get_encryption_key() (in module novelai_api.utils)": [[18, "novelai_api.utils.get_encryption_key"]], "link_content_to_story() (in module novelai_api.utils)": [[18, "novelai_api.utils.link_content_to_story"]], "novelai_api.utils": [[18, "module-novelai_api.utils"]], "tokenize_if_not() (in module novelai_api.utils)": [[18, "novelai_api.utils.tokenize_if_not"]], "tokens_to_b64() (in module novelai_api.utils)": [[18, "novelai_api.utils.tokens_to_b64"]], "unlink_content_from_story() (in module novelai_api.utils)": [[18, "novelai_api.utils.unlink_content_from_story"]], "aimodules_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.aimodules_integrity"]], "keystore_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.keystore_integrity"]], "preset_from_default() (in module tests.api.test_textgen_presets)": [[19, "tests.api.test_textgen_presets.preset_from_default"]], "preset_from_official() (in module tests.api.test_textgen_presets)": [[19, "tests.api.test_textgen_presets.preset_from_official"]], "presets_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.presets_integrity"]], "shelves_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.shelves_integrity"]], "stories_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.stories_integrity"]], "storycontent_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.storycontent_integrity"]], "test_presets() (in module tests.api.test_textgen_presets)": [[19, "tests.api.test_textgen_presets.test_presets"]], "tests.api.test_decrypt_encrypt_integrity_check": [[19, "module-tests.api.test_decrypt_encrypt_integrity_check"]], "tests.api.test_imagegen_samplers": [[19, "module-tests.api.test_imagegen_samplers"]], "tests.api.test_sync_gen": [[19, "module-tests.api.test_sync_gen"]], "tests.api.test_textgen_presets": [[19, "module-tests.api.test_textgen_presets"]], "api (class in tests.api.boilerplate)": [[20, "tests.api.boilerplate.API"]], "jsonencoder (class in tests.api.boilerplate)": [[20, "tests.api.boilerplate.JSONEncoder"]], "api_handle() (in module tests.api.boilerplate)": [[20, "tests.api.boilerplate.api_handle"]], "api_handle_sync() (in module tests.api.boilerplate)": [[20, "tests.api.boilerplate.api_handle_sync"]], "dumps() (in module tests.api.boilerplate)": [[20, "tests.api.boilerplate.dumps"]], "error_handler() (in module tests.api.boilerplate)": [[20, "tests.api.boilerplate.error_handler"]], "tests.api.boilerplate": [[20, "module-tests.api.boilerplate"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["example/example", "example/example.boilerplate", "index", "novelai_api/novelai_api", "novelai_api/novelai_api.BanList", "novelai_api/novelai_api.BiasGroup", "novelai_api/novelai_api.GlobalSettings", "novelai_api/novelai_api.Idstore", "novelai_api/novelai_api.ImagePreset", "novelai_api/novelai_api.Keystore", "novelai_api/novelai_api.NovelAIError", "novelai_api/novelai_api.NovelAI_API", "novelai_api/novelai_api.Preset", "novelai_api/novelai_api.SchemaValidator", "novelai_api/novelai_api.StoryHandler", "novelai_api/novelai_api.Tokenizer", "novelai_api/novelai_api.high_level", "novelai_api/novelai_api.low_level", "novelai_api/novelai_api.utils", "tests/api/api", "tests/api/api.boilerplate", "tests/mock/mock"], "filenames": ["example/example.rst", "example/example.boilerplate.rst", "index.rst", "novelai_api/novelai_api.rst", "novelai_api/novelai_api.BanList.rst", "novelai_api/novelai_api.BiasGroup.rst", "novelai_api/novelai_api.GlobalSettings.rst", "novelai_api/novelai_api.Idstore.rst", "novelai_api/novelai_api.ImagePreset.rst", "novelai_api/novelai_api.Keystore.rst", "novelai_api/novelai_api.NovelAIError.rst", "novelai_api/novelai_api.NovelAI_API.rst", "novelai_api/novelai_api.Preset.rst", "novelai_api/novelai_api.SchemaValidator.rst", "novelai_api/novelai_api.StoryHandler.rst", "novelai_api/novelai_api.Tokenizer.rst", "novelai_api/novelai_api.high_level.rst", "novelai_api/novelai_api.low_level.rst", "novelai_api/novelai_api.utils.rst", "tests/api/api.rst", "tests/api/api.boilerplate.rst", "tests/mock/mock.rst"], "titles": ["example directory", "boilerplate", "novelai-api", "novelai-api package", "novelai_api.BanList", "novelai_api.BiasGroup", "novelai_api.GlobalSettings", "novelai_api.Idstore", "novelai_api.ImagePreset", "novelai_api.Keystore", "novelai_api.NovelAIError", "novelai_api.NovelAI_API", "novelai_api.Preset", "novelai_api.SchemaValidator", "novelai_api.StoryHandler", "novelai_api.Tokenizer", "novelai_api.high_level", "novelai_api.low_level", "novelai_api.utils", "API directory", "boilerplate", "Mock directory"], "terms": {"nai_usernam": [0, 1, 19], "nai_password": [0, 1, 19], "valu": [0, 5, 6, 8, 12, 17, 19], "provid": [0, 7, 8, 10, 12, 15, 17, 19, 20], "via": [0, 16, 19], "environ": [0, 1, 19], "variabl": [0, 1, 19], "thei": [0, 19], "can": [0, 1, 2, 4, 5, 11, 16, 18, 19], "through": [0, 2, 16, 17, 19], "env": [0, 19], "file": [0, 8, 12, 19], "root": [0, 19], "project": [0, 19], "The": [0, 2, 8, 9, 11, 12, 16, 17, 19, 20], "nai_proxi": [0, 19], "i": [0, 2, 4, 5, 6, 8, 9, 12, 15, 16, 17, 18, 19, 20], "also": [0, 8, 16, 19], "support": [0, 1, 17, 19, 20], "inject": [0, 19], "proxi": [0, 11, 14, 19], "address": [0, 1, 11, 17, 19], "If": [0, 16, 18], "you": [0, 2, 16], "have": [0, 16, 18], "novelai": [0, 8, 11, 12, 16, 17], "api": [0, 1, 10, 11, 12, 14, 16, 17, 18, 20], "packag": [0, 2], "instal": [0, 2, 19], "pip": [0, 2], "python": [0, 2, 12], "filenam": [0, 19], "don": 0, "t": [0, 2, 7, 14, 15, 17, 18], "re": [0, 15, 16], "activ": [0, 2], "develop": 0, "poetri": [0, 2, 19], "run": [0, 2, 19, 20], "rememb": [0, 19], "befor": [0, 2, 16, 17, 19, 20], "alreadi": [0, 18, 19], "done": [0, 16, 17, 19], "how": [0, 17], "download": [0, 2, 16, 17, 19], "decrypt": [0, 2, 9, 16, 18, 19], "modul": [0, 16, 17], "from": [0, 2, 5, 6, 8, 9, 12, 14, 16, 17, 18], "account": [0, 2, 6, 8, 16, 17], "decompress": [0, 18, 19], "shelv": [0, 19], "stori": [0, 14, 16, 18, 19], "queri": 0, "controlnet": [0, 8, 17], "mask": [0, 8, 17], "an": [0, 5, 6, 8, 11, 12, 17, 18, 20], "imag": [0, 8, 16, 17], "It": [0, 2], "expect": [0, 10], "result": [0, 19], "png": [0, 8, 17], "exist": [0, 14, 16], "gener": [0, 6, 8, 12, 14, 16, 17], "thi": [0, 2, 11, 12, 14, 15, 16, 17, 19], "same": [0, 12], "folder": [0, 19], "note": 0, "current": [0, 6, 8, 11, 12, 17, 19], "return": [0, 4, 5, 6, 7, 8, 12, 14, 15, 16, 17, 18], "wrong": [0, 17], "due": 0, "convers": 0, "frontend": [0, 2], "see": 0, "issu": 0, "15": 0, "place": 0, "name": [0, 12, 13, 15, 16, 17, 19], "test": [0, 19, 20], "which": [0, 11, 19], "sampler": [0, 8, 19], "work": [0, 2, 8, 11, 12, 19], "creat": [0, 4, 5, 6, 7, 8, 9, 11, 14], "one": [0, 2, 8, 12, 16, 17], "per": 0, "control": 0, "net": [0, 2, 8, 11, 12], "img2img": [0, 8], "text": [0, 2, 6, 12, 15, 16, 17], "direct": 0, "standard": 0, "error": [0, 10, 16, 20], "output": [0, 2, 17], "stderr": 0, "voic": [0, 17], "tt": [0, 17], "To": [0, 2, 16, 17], "speech": [0, 17], "audio": [0, 17], "sampl": [0, 8, 12], "input": [0, 2, 17], "limit": [0, 16, 17], "1000": [0, 17], "charact": [0, 17], "cut": [0, 17], "backend": [0, 17], "tag": [0, 17], "suggest": [0, 17], "gen": [0, 17], "upscal": [0, 17], "should": [0, 2, 9, 12, 14, 16, 17], "512x768": 0, "default": [0, 1, 8, 11, 12, 17, 20], "modifi": 0, "image_s": 0, "chang": [0, 8, 17], "boilerpl": [0, 19], "jsonencod": [0, 1, 19, 20], "dump": [0, 1, 19, 20], "class": [1, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 19, 20], "sourc": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20], "base": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 20], "object": [1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20], "redund": 1, "part": 1, "us": [1, 4, 5, 6, 8, 11, 12, 15, 16, 17, 19, 20], "context": [1, 12, 16, 17], "manag": [1, 2, 8], "automat": 1, "login": [1, 2, 16, 17], "usag": 1, "async": [1, 14, 16, 17, 19, 20], "encryption_kei": [1, 20], "logger": [1, 11, 20], "do": [1, 20], "stuff": 1, "A": [1, 2, 16, 17], "custom": 1, "pass": [1, 2, 16, 17], "constructor": [1, 19], "replac": [1, 14], "base_address": [1, 11], "__init__": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 20], "option": [1, 8, 9, 11, 12, 14, 16, 17, 18, 20], "str": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20], "none": [1, 8, 10, 11, 12, 14, 16, 17, 18, 20], "log": [1, 11, 16, 17, 20], "novelai_api": [1, 2, 3, 20], "novelaiapi": [1, 2, 3, 11, 14, 16, 17, 20], "properti": [1, 11, 20], "json": [1, 20], "encod": [1, 2, 8, 15, 16, 17, 18, 20], "extend": [1, 20], "byte": [1, 8, 9, 12, 14, 16, 17, 18, 20], "o": [1, 8, 12, 15, 18, 20], "ani": [1, 2, 5, 6, 8, 9, 12, 13, 14, 16, 17, 18, 20], "e": [1, 20], "shortcut": [1, 20], "configur": [1, 8, 12, 20], "consist": [1, 19, 20], "rest": 2, "intend": 2, "helper": [2, 11], "": [2, 15, 16, 17, 19], "categori": 2, "badg": 2, "pypi": 2, "qualiti": 2, "stat": 2, "endpoint": [2, 17], "m": 2, "get_access_kei": [2, 3, 18], "usernam": [2, 16], "password": [2, 16, 18], "valid": [2, 12, 13, 17], "30": 2, "dai": 2, "requir": 2, "most": [2, 16, 17], "get_access_token": 2, "user": [2, 16], "content": [2, 16, 17, 18], "print": [2, 17], "what": 2, "couldn": 2, "sanity_check": 2, "b64": [2, 8, 16, 17, 18], "model": [2, 3, 4, 5, 6, 8, 12, 14, 15, 16, 17, 18], "data": [2, 5, 9, 12, 16, 17, 18], "full": 2, "list": [2, 4, 5, 12, 14, 15, 16, 17, 18], "avail": 2, "directori": 2, "split": 2, "2": [2, 8, 12, 14, 17], "group": [2, 5], "low": [2, 11, 17], "level": [2, 11, 16, 17], "interfac": 2, "strict": 2, "implement": [2, 17], "offici": [2, 12], "http": [2, 8, 11, 12], "onli": [2, 5, 12, 17, 19], "type": [2, 8, 16, 17], "assert": 2, "schema": [2, 17], "is_schema_validation_en": [2, 17], "true": [2, 4, 5, 12, 16, 17], "high": [2, 8, 11, 16], "build": [2, 16, 17], "easier": 2, "handl": [2, 15, 20], "complex": 2, "set": [2, 6, 8, 12, 16, 17], "mani": 2, "task": 2, "all": [2, 16, 17, 19], "relev": [2, 12, 16, 17], "ar": [2, 12, 16, 17], "venv": 2, "featur": 2, "enhanc": 2, "pr": 2, "pre": [2, 16], "commit": 2, "submiss": 2, "hook": 2, "nai": [2, 8, 10, 19], "warn": [2, 17], "wip": 2, "doe": [2, 14, 18], "yet": [2, 7], "local": 2, "viewabl": 2, "html": [2, 8, 12], "index": [2, 14, 17, 18], "trello": 2, "banlist": [2, 3, 14, 16], "biasgroup": [2, 3, 14, 16], "globalset": [2, 3, 14, 16], "idstor": [2, 3, 14], "imagepreset": [2, 3, 15, 16, 17], "keystor": [2, 3, 14, 16, 17, 18, 19], "novelaierror": [2, 3, 16], "preset": [2, 3, 4, 5, 6, 8, 14, 15, 16, 17, 18, 19], "schemavalid": [2, 3], "storyhandl": [2, 3], "util": [2, 3, 9, 16], "low_level": [3, 8, 11], "print_with_paramet": [3, 17], "lowlevel": [3, 11, 17], "high_level": [3, 11], "highlevel": [3, 11, 16], "imagemodel": [3, 8, 15, 16, 17], "controlnetmodel": [3, 8, 17], "imageresolut": [3, 8], "imagesampl": [3, 8, 17], "ucpreset": [3, 8], "imagegenerationtyp": [3, 8, 16, 17], "order": [3, 12], "enum_contain": [3, 12], "collapse_model": [3, 12], "strenum": [3, 12], "phrasereppen": [3, 12], "preambl": [3, 12], "presetview": [3, 12], "novelaistori": [3, 14], "novelaistorystorag": [3, 14], "token": [3, 4, 5, 6, 12, 16, 17, 18], "sentencepiec": [3, 15], "argon_hash": [3, 18], "get_encryption_kei": [3, 9, 18], "decrypt_data": [3, 18], "encrypt_data": [3, 18], "decompress_user_data": [3, 18], "compress_user_data": [3, 18], "decrypt_user_data": [3, 16, 18], "encrypt_user_data": [3, 16, 18], "link_content_to_stori": [3, 18], "unlink_content_from_stori": [3, 18], "get_decrypted_user_data": [3, 18], "tokens_to_b64": [3, 18], "b64_to_token": [3, 16, 18], "extract_preset_data": [3, 18], "tokenize_if_not": [3, 18], "sequenc": [4, 5, 12], "union": [4, 5, 8, 11, 12, 15, 16, 17, 18], "int": [4, 5, 6, 8, 10, 12, 14, 15, 16, 17, 18, 20], "enabl": [4, 5, 8, 12, 17], "bool": [4, 5, 6, 8, 12, 14, 16, 17, 18, 20], "ban": [4, 16], "given": [4, 12, 17], "element": [4, 5], "string": [4, 5, 17, 18], "recommend": [4, 5], "flexibl": [4, 5], "between": [4, 5, 11], "paramet": [4, 5, 6, 8, 9, 11, 12, 14, 15, 16, 17, 18, 20], "add": [4, 5, 15, 20], "dict": [4, 5, 6, 8, 9, 12, 14, 15, 16, 17, 18], "get_tokenized_entri": [4, 5], "iter": [4, 5, 16, 18], "bia": [5, 16], "float": [5, 8, 11, 12, 17], "ensure_sequence_finish": 5, "fals": [5, 12, 14, 16, 17, 18, 20], "generate_onc": 5, "neg": 5, "downbia": 5, "posit": 5, "upbia": 5, "ensur": [5, 19], "complet": [5, 16, 17], "bias": [5, 6, 14, 16], "first": [5, 20], "occurr": 5, "classmethod": [5, 8, 12, 13, 15], "from_data": 5, "store": [6, 8, 12, 16], "global": [6, 16], "generate_until_sent": 6, "up": [6, 16], "20": 6, "after": [6, 20], "max_length": [6, 12], "end": [6, 14], "sentenc": 6, "found": [6, 12], "within": 6, "num_logprob": 6, "number": [6, 8, 12, 17, 20], "logprob": 6, "each": [6, 15, 16, 18, 20], "no_logprob": 6, "disabl": [6, 12, 17, 19], "ban_bracket": 6, "appli": 6, "bracket": 6, "bias_dinkus_aster": 6, "dinkus_aster": 6, "ban_ambiguous_genji_token": 6, "genji_ambiguous_token": 6, "genji": [6, 12], "rep_pen_whitelist": 6, "repetit": [6, 12], "penalti": [6, 12], "whitelist": [6, 12], "1": [6, 8, 10, 12, 17, 19], "copi": [6, 8, 12], "new": [6, 7, 8, 9, 11, 12, 16, 17], "to_set": [6, 8, 12], "regist": [7, 16, 17], "arg": [7, 17], "id": [7, 14, 16, 17, 18], "everi": 7, "item": [7, 18], "must": [7, 16, 17, 18, 20], "retriev": [7, 16, 18], "download_user_cont": 7, "uniqu": 7, "hasn": 7, "been": [7, 16, 17, 18], "enum": [8, 12, 17], "suggest_tag": [8, 17], "generate_imag": [8, 16, 17], "anime_cur": 8, "safe": 8, "diffus": 8, "anime_ful": 8, "furri": 8, "inainting_anime_cur": 8, "inpaint": 8, "inpainting_anime_ful": 8, "inpainting_furri": 8, "controlnet_model": 8, "generate_controlnet_mask": [8, 17], "palette_swap": 8, "hed": 8, "form_lock": 8, "mida": 8, "scribbler": 8, "fake_scribbl": 8, "building_control": 8, "mlsd": 8, "landscap": 8, "uniform": 8, "resolut": 8, "small_portrait": 8, "384": 8, "640": 8, "small_landscap": 8, "small_squar": 8, "512": 8, "normal_portrait": 8, "768": 8, "normal_landscap": 8, "normal_squar": 8, "large_portrait": 8, "1024": 8, "large_landscap": 8, "large_squar": 8, "k_lm": 8, "k_euler": 8, "k_euler_ancestr": 8, "k_heun": 8, "plm": 8, "ddim": 8, "nai_smea": 8, "nai_smea_dyn": 8, "k_dpmpp_2m": 8, "k_dpmpp_2s_ancestr": 8, "k_dpmpp_sde": 8, "k_dpm_2": 8, "k_dpm_2_ancestr": 8, "k_dpm_adapt": 8, "k_dpm_fast": 8, "uc": 8, "uc_preset": 8, "preset_low_quality_bad_anatomi": 8, "0": [8, 12, 17], "preset_low_qu": 8, "preset_bad_anatomi": 8, "preset_non": 8, "3": [8, 12, 17], "normal": [8, 16], "infil": 8, "quality_toggl": 8, "doc": [8, 12], "qualitytag": 8, "tupl": [8, 16, 17, 18], "width": [8, 17], "height": [8, 17], "prepend": 8, "n_sampl": 8, "seed": [8, 17], "random": [8, 9, 12], "ith": 8, "ha": [8, 16, 17, 18], "nois": 8, "strengthnois": 8, "strength": 8, "scale": [8, 17], "stepsguid": 8, "call": [8, 16, 17, 20], "prompt": [8, 12, 16, 17], "guidanc": 8, "step": [8, 17], "undesiredcont": 8, "smea": 8, "make": [8, 11], "larg": 8, "smea_dyn": 8, "dyn": 8, "best": 8, "wallpap": 8, "controlnet_condit": [8, 17], "gotten": 8, "method": [8, 15, 16, 17, 18], "controlnet_strength": 8, "influenc": 8, "chosen": [8, 12, 15], "decrisp": 8, "reduc": 8, "deepfri": 8, "effect": 8, "twitter": 8, "com": [8, 12], "birchlab": 8, "statu": [8, 10, 17], "1582165379832348672": 8, "add_original_imag": 8, "prevent": 8, "seam": 8, "along": 8, "edg": 8, "mai": 8, "slightli": 8, "black": 8, "white": 8, "area": 8, "last_se": 8, "when": [8, 10, 12, 16], "metadata": 8, "might": 8, "hassl": 8, "updat": [8, 12], "kwarg": [8, 12, 16], "like": [8, 12], "instanc": [8, 14], "function": [8, 12, 16, 17, 20], "get": [8, 12, 15, 17], "get_max_n_sampl": 8, "allow": [8, 12, 17], "max": 8, "calculate_cost": 8, "is_opu": 8, "calcul": 8, "cost": 8, "anla": 8, "subscript": [8, 17], "tier": [8, 17], "opu": [8, 17], "free": [8, 14, 17], "so": 8, "from_fil": [8, 12], "path": [8, 12], "pathlik": [8, 12], "write": [8, 12], "read": 8, "to_fil": [8, 12], "load": [8, 14], "meta": [9, 14, 16, 17], "assign": 9, "nonc": [9, 18], "kei": [9, 12, 14, 16, 17, 18], "encrypt": [9, 16, 17, 18, 19], "comput": [9, 16], "except": 10, "rais": [10, 20], "problem": [10, 19], "occur": 10, "url": [10, 11], "messag": 10, "caus": 10, "code": 10, "wa": [10, 12, 17], "lib_root": 11, "home": 11, "runner": 11, "session": 11, "aiohttp": 11, "client": 11, "clientsess": 11, "interact": 11, "attribut": 11, "purpos": 11, "attach_sess": 11, "detach_sess": 11, "switch": 11, "synchron": 11, "asynchron": 11, "request": [11, 16, 17], "attach": 11, "empti": [11, 12], "header": 11, "multidict": 11, "_multidict": 11, "cimultidict": 11, "cooki": 11, "simplecooki": 11, "yarl": 11, "proxy_auth": 11, "basicauth": 11, "authent": 11, "_low_level": 11, "thin": 11, "wrapper": [11, 15], "_high_level": 11, "abstract": [11, 15], "top": [11, 12, 16, 17], "detach": 11, "timeout": 11, "second": [11, 18, 20], "intenum": [12, 17], "enumer": 12, "temperatur": [12, 17], "top_k": 12, "top_p": 12, "tf": 12, "top_a": 12, "4": [12, 17], "typical_p": 12, "5": [12, 20], "cfg": 12, "6": 12, "enum_class": 12, "enummeta": 12, "check": [12, 16, 17, 19], "collaps": 12, "multipl": [12, 16, 17], "version": [12, 17], "last": 12, "sigurd": 12, "6b": 12, "v4": 12, "euterp": [12, 14], "v2": [12, 14, 17], "krake": 12, "clio": 12, "v1": [12, 17], "kayra": 12, "jp": 12, "snek": 12, "hypebot": 12, "inlin": 12, "infillmodel": 12, "enum_member_valu": 12, "off": 12, "verylight": 12, "very_light": 12, "light": 12, "medium": 12, "aggress": 12, "veryaggress": 12, "very_aggress": 12, "n": [12, 19], "author": 12, "variou": [12, 17], "prologu": 12, "60": 12, "198": 12, "endoftext": 12, "sent": [12, 17, 18], "officials_valu": 12, "diversity_penalti": 12, "length_penalti": 12, "40": 12, "min_length": 12, "phrase_rep_pen": 12, "repetition_penalti": 12, "repetition_penalty_default_whitelist": 12, "repetition_penalty_frequ": 12, "repetition_penalty_pres": 12, "repetition_penalty_rang": 12, "repetition_penalty_slop": 12, "repetition_penalty_whitelist": 12, "stop_sequ": 12, "tail_free_sampl": 12, "textgenerationsettingsvers": 12, "naidb": 12, "mirahez": 12, "org": 12, "wiki": 12, "generation_set": 12, "randomness_": 12, "respons": [12, 17], "length": [12, 17], "interrupt": 12, "stop": 12, "minimum": 12, "k_sampl": 12, "a_sampl": 12, "nucleus_sampl": 12, "typical_sampl": 12, "arxiv": 12, "pdf": 12, "2202": 12, "00666": 12, "tail": 12, "free_sampl": 12, "1909": 12, "05858": 12, "rang": 12, "cover": 12, "platform": 12, "openai": 12, "refer": 12, "detail": 12, "exclud": 12, "color": 12, "whether": 12, "compat": 12, "save": [12, 14], "huggingfac": 12, "co": 12, "transform": [12, 18], "main_class": 12, "pretrainedconfig": 12, "cfg_scale": 12, "cfg_uc": 12, "pad_token_id": 12, "text_gener": 12, "generationconfig": 12, "bos_token_id": 12, "eos_token_id": 12, "max_tim": 12, "no_repeat_ngram_s": 12, "encoder_no_repeat_ngram_s": 12, "num_return_sequ": 12, "get_hidden_st": 12, "output_hidden_st": 12, "process": 12, "noreturn": [12, 17], "instanti": 12, "from_preset_data": 12, "from_offici": [12, 19], "mean": [12, 16], "from_default": [12, 19], "obj": 13, "text_generation_settings_vers": 14, "default_model": 14, "prefix": [14, 16], "global_set": [14, 16], "storycont": [14, 16, 19], "tree": 14, "context_s": 14, "build_context": 14, "edit": 14, "start": [14, 16, 17], "undo": 14, "redo": 14, "upload": [14, 16, 17], "choos": 14, "flatten": 14, "delet": [14, 17], "get_current_tre": 14, "storag": [14, 17], "here": 14, "load_from_remot": 14, "select": [14, 17], "story_id": 14, "previous": 14, "ones": 14, "handler": 14, "unload": 14, "ing": 14, "novelai_storyproxi": 14, "sentencepieceprocessor": 15, "around": 15, "decod": [15, 16, 18], "model_path": 15, "trans_table_id": 15, "trans_table_str": 15, "trans_regex_str": 15, "pattern": 15, "workaround": 15, "need": [15, 17], "becaus": 15, "cannot": 15, "some": 15, "behind": 15, "get_tokenizer_nam": 15, "meant": [16, 17], "directli": [16, 17, 20], "rather": [16, 17], "parent": [16, 17], "recapcha": [16, 17], "email": [16, 17, 18], "send_mail": 16, "giftkei": [16, 17], "websit": [16, 17], "send": [16, 17], "mail": 16, "hash": [16, 17], "recoveri": [16, 17], "success": [16, 17], "access": [16, 17], "login_from_token": 16, "access_kei": [16, 17], "instead": 16, "get_keystor": [16, 17, 18], "readabl": [16, 17], "manner": 16, "map": 16, "throw": 16, "repeatedli": 16, "your": [16, 17], "internet": 16, "connect": 16, "integr": [16, 19], "lose": [16, 17], "overwrit": [16, 17], "set_keystor": [16, 17], "raw": [16, 17], "serial": [16, 17], "download_user_stori": 16, "download_user_story_cont": 16, "download_user_preset": 16, "download_user_modul": 16, "aimodul": [16, 19], "download_user_shelv": 16, "shelf": 16, "upload_user_cont": 16, "compress": [16, 18, 19], "succeed": 16, "otherwis": 16, "even": 16, "fail": 16, "bad_word": 16, "onc": 16, "finish": [16, 17], "As": [16, 17], "accept": [16, 17, 20], "go": [16, 17], "beyond": [16, 17], "truncat": [16, 17], "give": 16, "ai": [16, 17], "down": 16, "addit": 16, "generate_stream": 16, "asynciter": [16, 17], "time": [16, 18, 20], "action": [16, 17], "describ": 16, "want": 16, "pair": [16, 17], "nice": 17, "wai": 17, "download_object": 17, "stream": 17, "post": 17, "is_reach": 17, "reachabl": 17, "change_access_kei": 17, "current_kei": 17, "new_kei": 17, "new_email": 17, "send_email_verif": 17, "verif": 17, "verify_email": 17, "verification_token": 17, "get_inform": 17, "extens": 17, "inform": 17, "about": 17, "request_account_recoveri": 17, "lost": 17, "differ": 17, "recover_account": 17, "recovery_token": 17, "delete_cont": 17, "recov": 17, "delete_account": 17, "get_data": 17, "get_prior": 17, "prioriti": 17, "system": 17, "legaci": 17, "isn": 17, "realli": 17, "import": 17, "subscriptionti": 17, "paper": 17, "trial": 17, "tablet": 17, "scroll": 17, "get_subscript": 17, "equal": 17, "object_typ": 17, "upload_object": 17, "link": [17, 18], "object_id": 17, "delete_object": 17, "get_set": 17, "format": 17, "arbitrari": 17, "set_set": 17, "bind_subscript": 17, "payment_processor": 17, "subscription_id": 17, "bind": 17, "payment": 17, "renew": 17, "monthli": 17, "change_subscript": 17, "new_plan": 17, "still": 17, "bound": 17, "param": 17, "generate_prompt": 17, "temp": 17, "upscale_imag": 17, "afaik": 17, "factor": 17, "final": 17, "classifi": 17, "Not": 17, "certain": 17, "confid": 17, "consid": 17, "much": 17, "dataset": 17, "other": [17, 19], "similar": 17, "generate_voic": 17, "synthes": 17, "side": 17, "webm": 17, "mp3": 17, "train_modul": 17, "rate": 17, "desc": 17, "train": 17, "singl": 17, "learn": 17, "descript": 17, "being": 17, "get_trained_modul": 17, "module_id": 17, "delete_modul": 17, "got": 17, "buy_step": 17, "amount": 17, "size": 18, "domain": 18, "is_compress": 18, "ref": 18, "doesn": 18, "utf8": 18, "translat": 18, "won": 18, "story_cont": 18, "remov": 18, "filter": 18, "out": 18, "base64": 18, "For": 19, "under": 19, "specif": 19, "pytest": [19, 20], "scheme": 19, "keystore_integr": 19, "verifi": 19, "stories_integr": 19, "storycontent_integr": 19, "presets_integr": 19, "aimodules_integr": 19, "shelves_integr": 19, "sync": [19, 20], "capabl": 19, "without": [19, 20], "right": 19, "job": 19, "pertain": 19, "test_preset": 19, "preset_from_default": 19, "preset_from_offici": 19, "automodul": 19, "member": 19, "error_handl": [19, 20], "api_handl": [19, 20], "api_handle_sync": [19, 20], "func_ext": 20, "callabl": 20, "await": 20, "attempt": 20, "wait": 20, "decor": 20, "argument": 20, "substitut": 20, "func": 20, "fixtur": 20}, "objects": {"example": [[1, 0, 0, "-", "boilerplate"], [0, 0, 0, "-", "download_modules"], [0, 0, 0, "-", "download_presets"], [0, 0, 0, "-", "download_shelves"], [0, 0, 0, "-", "download_stories_and_content"], [0, 0, 0, "-", "generate_controlnet_masks"], [0, 0, 0, "-", "generate_image"], [0, 0, 0, "-", "generate_image_test_samplers"], [0, 0, 0, "-", "generate_image_with_controlnet"], [0, 0, 0, "-", "generate_image_with_img2img"], [0, 0, 0, "-", "generate_text"], [0, 0, 0, "-", "generate_voice"], [0, 0, 0, "-", "login"], [0, 0, 0, "-", "login_with_proxy"], [0, 0, 0, "-", "suggest_tags"], [0, 0, 0, "-", "upscale_image"]], "example.boilerplate": [[1, 1, 1, "", "API"], [1, 1, 1, "", "JSONEncoder"], [1, 5, 1, "", "dumps"]], "example.boilerplate.API": [[1, 2, 1, "", "__init__"], [1, 3, 1, "", "api"], [1, 4, 1, "", "encryption_key"], [1, 3, 1, "", "logger"]], "example.boilerplate.JSONEncoder": [[1, 2, 1, "", "default"]], "novelai_api": [[4, 0, 0, "-", "BanList"], [5, 0, 0, "-", "BiasGroup"], [6, 0, 0, "-", "GlobalSettings"], [7, 0, 0, "-", "Idstore"], [8, 0, 0, "-", "ImagePreset"], [9, 0, 0, "-", "Keystore"], [10, 0, 0, "-", "NovelAIError"], [11, 0, 0, "-", "NovelAI_API"], [12, 0, 0, "-", "Preset"], [13, 0, 0, "-", "SchemaValidator"], [14, 0, 0, "-", "StoryHandler"], [15, 0, 0, "-", "Tokenizer"], [16, 0, 0, "-", "_high_level"], [17, 0, 0, "-", "_low_level"], [18, 0, 0, "-", "utils"]], "novelai_api.BanList": [[4, 1, 1, "", "BanList"]], "novelai_api.BanList.BanList": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "add"], [4, 3, 1, "", "enabled"], [4, 2, 1, "", "get_tokenized_entries"]], "novelai_api.BiasGroup": [[5, 1, 1, "", "BiasGroup"]], "novelai_api.BiasGroup.BiasGroup": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "add"], [5, 3, 1, "", "bias"], [5, 3, 1, "", "enabled"], [5, 3, 1, "", "ensure_sequence_finish"], [5, 2, 1, "", "from_data"], [5, 3, 1, "", "generate_once"], [5, 2, 1, "", "get_tokenized_entries"]], "novelai_api.GlobalSettings": [[6, 1, 1, "", "GlobalSettings"]], "novelai_api.GlobalSettings.GlobalSettings": [[6, 3, 1, "", "NO_LOGPROBS"], [6, 2, 1, "", "__init__"], [6, 3, 1, "", "ban_ambiguous_genji_tokens"], [6, 3, 1, "", "ban_brackets"], [6, 3, 1, "", "bias_dinkus_asterism"], [6, 2, 1, "", "copy"], [6, 3, 1, "", "generate_until_sentence"], [6, 3, 1, "", "num_logprobs"], [6, 3, 1, "", "rep_pen_whitelist"], [6, 2, 1, "", "to_settings"]], "novelai_api.Idstore": [[7, 1, 1, "", "Idstore"]], "novelai_api.Idstore.Idstore": [[7, 2, 1, "", "__init__"], [7, 2, 1, "", "create"], [7, 2, 1, "", "register"]], "novelai_api.ImagePreset": [[8, 1, 1, "", "ControlNetModel"], [8, 1, 1, "", "ImageGenerationType"], [8, 1, 1, "", "ImageModel"], [8, 1, 1, "", "ImagePreset"], [8, 1, 1, "", "ImageResolution"], [8, 1, 1, "", "ImageSampler"], [8, 1, 1, "", "UCPreset"]], "novelai_api.ImagePreset.ControlNetModel": [[8, 3, 1, "", "Building_Control"], [8, 3, 1, "", "Form_Lock"], [8, 3, 1, "", "Landscaper"], [8, 3, 1, "", "Palette_Swap"], [8, 3, 1, "", "Scribbler"]], "novelai_api.ImagePreset.ImageGenerationType": [[8, 3, 1, "", "IMG2IMG"], [8, 3, 1, "", "INPAINTING"], [8, 3, 1, "", "NORMAL"]], "novelai_api.ImagePreset.ImageModel": [[8, 3, 1, "", "Anime_Curated"], [8, 3, 1, "", "Anime_Full"], [8, 3, 1, "", "Furry"], [8, 3, 1, "", "Inainting_Anime_Curated"], [8, 3, 1, "", "Inpainting_Anime_Full"], [8, 3, 1, "", "Inpainting_Furry"]], "novelai_api.ImagePreset.ImagePreset": [[8, 2, 1, "", "__init__"], [8, 3, 1, "", "add_original_image"], [8, 2, 1, "", "calculate_cost"], [8, 3, 1, "", "controlnet_condition"], [8, 3, 1, "", "controlnet_model"], [8, 3, 1, "", "controlnet_strength"], [8, 2, 1, "", "copy"], [8, 3, 1, "", "decrisper"], [8, 2, 1, "", "from_file"], [8, 2, 1, "", "get_max_n_samples"], [8, 3, 1, "", "image"], [8, 3, 1, "", "last_seed"], [8, 3, 1, "", "mask"], [8, 3, 1, "", "n_samples"], [8, 3, 1, "", "noise"], [8, 3, 1, "", "quality_toggle"], [8, 3, 1, "", "resolution"], [8, 3, 1, "", "sampler"], [8, 3, 1, "", "scale"], [8, 3, 1, "", "seed"], [8, 3, 1, "", "smea"], [8, 3, 1, "", "smea_dyn"], [8, 3, 1, "", "steps"], [8, 3, 1, "", "strength"], [8, 2, 1, "", "to_file"], [8, 2, 1, "", "to_settings"], [8, 3, 1, "", "uc"], [8, 3, 1, "", "uc_preset"], [8, 2, 1, "", "update"]], "novelai_api.ImagePreset.ImageResolution": [[8, 3, 1, "", "Large_Landscape"], [8, 3, 1, "", "Large_Portrait"], [8, 3, 1, "", "Large_Square"], [8, 3, 1, "", "Normal_Landscape"], [8, 3, 1, "", "Normal_Portrait"], [8, 3, 1, "", "Normal_Square"], [8, 3, 1, "", "Small_Landscape"], [8, 3, 1, "", "Small_Portrait"], [8, 3, 1, "", "Small_Square"]], "novelai_api.ImagePreset.ImageSampler": [[8, 3, 1, "", "ddim"], [8, 3, 1, "", "k_dpm_2"], [8, 3, 1, "", "k_dpm_2_ancestral"], [8, 3, 1, "", "k_dpm_adaptive"], [8, 3, 1, "", "k_dpm_fast"], [8, 3, 1, "", "k_dpmpp_2m"], [8, 3, 1, "", "k_dpmpp_2s_ancestral"], [8, 3, 1, "", "k_dpmpp_sde"], [8, 3, 1, "", "k_euler"], [8, 3, 1, "", "k_euler_ancestral"], [8, 3, 1, "", "k_heun"], [8, 3, 1, "", "k_lms"], [8, 3, 1, "", "nai_smea"], [8, 3, 1, "", "nai_smea_dyn"], [8, 3, 1, "", "plms"]], "novelai_api.ImagePreset.UCPreset": [[8, 3, 1, "", "Preset_Bad_Anatomy"], [8, 3, 1, "", "Preset_Low_Quality"], [8, 3, 1, "", "Preset_Low_Quality_Bad_Anatomy"], [8, 3, 1, "", "Preset_None"]], "novelai_api.Keystore": [[9, 1, 1, "", "Keystore"]], "novelai_api.Keystore.Keystore": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "create"], [9, 3, 1, "", "data"], [9, 2, 1, "", "decrypt"], [9, 2, 1, "", "encrypt"]], "novelai_api.NovelAIError": [[10, 6, 1, "", "NovelAIError"]], "novelai_api.NovelAIError.NovelAIError": [[10, 2, 1, "", "__init__"], [10, 3, 1, "", "message"], [10, 3, 1, "", "status"], [10, 3, 1, "", "url"]], "novelai_api.NovelAI_API": [[11, 1, 1, "", "NovelAIAPI"]], "novelai_api.NovelAI_API.NovelAIAPI": [[11, 3, 1, "", "BASE_ADDRESS"], [11, 3, 1, "", "LIB_ROOT"], [11, 2, 1, "", "__init__"], [11, 2, 1, "", "attach_session"], [11, 3, 1, "", "cookies"], [11, 2, 1, "", "detach_session"], [11, 3, 1, "", "headers"], [11, 3, 1, "", "high_level"], [11, 3, 1, "", "logger"], [11, 3, 1, "", "low_level"], [11, 3, 1, "", "proxy"], [11, 3, 1, "", "proxy_auth"], [11, 3, 1, "", "session"], [11, 4, 1, "", "timeout"]], "novelai_api.Preset": [[12, 1, 1, "", "Model"], [12, 1, 1, "", "Order"], [12, 7, 1, "", "PREAMBLE"], [12, 1, 1, "", "PhraseRepPen"], [12, 1, 1, "", "Preset"], [12, 1, 1, "", "PresetView"], [12, 1, 1, "", "StrEnum"], [12, 5, 1, "", "collapse_model"], [12, 5, 1, "", "enum_contains"]], "novelai_api.Preset.Model": [[12, 3, 1, "", "Clio"], [12, 3, 1, "", "Euterpe"], [12, 3, 1, "", "Genji"], [12, 3, 1, "", "HypeBot"], [12, 3, 1, "", "Inline"], [12, 3, 1, "", "Kayra"], [12, 3, 1, "", "Krake"], [12, 3, 1, "", "Sigurd"], [12, 3, 1, "", "Snek"], [12, 3, 1, "", "enum_member_values"]], "novelai_api.Preset.Order": [[12, 3, 1, "", "CFG"], [12, 3, 1, "", "TFS"], [12, 3, 1, "", "Temperature"], [12, 3, 1, "", "Top_A"], [12, 3, 1, "", "Top_K"], [12, 3, 1, "", "Top_P"], [12, 3, 1, "", "Typical_P"]], "novelai_api.Preset.PhraseRepPen": [[12, 3, 1, "", "Aggressive"], [12, 3, 1, "", "Light"], [12, 3, 1, "", "Medium"], [12, 3, 1, "", "Off"], [12, 3, 1, "", "VeryAggressive"], [12, 3, 1, "", "VeryLight"]], "novelai_api.Preset.Preset": [[12, 3, 1, "", "DEFAULTS"], [12, 2, 1, "", "__init__"], [12, 3, 1, "", "bos_token_id"], [12, 3, 1, "", "cfg_scale"], [12, 3, 1, "", "cfg_uc"], [12, 2, 1, "", "copy"], [12, 3, 1, "", "diversity_penalty"], [12, 2, 1, "", "enable"], [12, 3, 1, "", "encoder_no_repeat_ngram_size"], [12, 3, 1, "", "eos_token_id"], [12, 2, 1, "", "from_default"], [12, 2, 1, "", "from_file"], [12, 2, 1, "", "from_official"], [12, 2, 1, "", "from_preset_data"], [12, 3, 1, "", "get_hidden_states"], [12, 3, 1, "", "length_penalty"], [12, 3, 1, "", "max_length"], [12, 3, 1, "", "max_time"], [12, 3, 1, "", "min_length"], [12, 3, 1, "", "model"], [12, 3, 1, "", "name"], [12, 3, 1, "", "no_repeat_ngram_size"], [12, 3, 1, "", "num_return_sequences"], [12, 3, 1, "", "order"], [12, 3, 1, "", "pad_token_id"], [12, 3, 1, "", "phrase_rep_pen"], [12, 3, 1, "", "repetition_penalty"], [12, 3, 1, "", "repetition_penalty_default_whitelist"], [12, 3, 1, "", "repetition_penalty_frequency"], [12, 3, 1, "", "repetition_penalty_presence"], [12, 3, 1, "", "repetition_penalty_range"], [12, 3, 1, "", "repetition_penalty_slope"], [12, 3, 1, "", "repetition_penalty_whitelist"], [12, 2, 1, "", "set"], [12, 3, 1, "", "tail_free_sampling"], [12, 3, 1, "", "temperature"], [12, 3, 1, "", "textGenerationSettingsVersion"], [12, 2, 1, "", "to_file"], [12, 2, 1, "", "to_settings"], [12, 3, 1, "", "top_a"], [12, 3, 1, "", "top_k"], [12, 3, 1, "", "top_p"], [12, 3, 1, "", "typical_p"], [12, 2, 1, "", "update"]], "novelai_api.Preset.PresetView": [[12, 2, 1, "", "__init__"], [12, 3, 1, "", "model"]], "novelai_api.SchemaValidator": [[13, 1, 1, "", "SchemaValidator"]], "novelai_api.SchemaValidator.SchemaValidator": [[13, 2, 1, "", "__init__"], [13, 2, 1, "", "validate"]], "novelai_api.StoryHandler": [[14, 1, 1, "", "NovelAIStory"], [14, 1, 1, "", "NovelAIStoryStorage"]], "novelai_api.StoryHandler.NovelAIStory": [[14, 3, 1, "", "DEFAULT_MODEL"], [14, 3, 1, "", "TEXT_GENERATION_SETTINGS_VERSION"], [14, 2, 1, "", "__init__"], [14, 3, 1, "", "api"], [14, 3, 1, "", "banlists"], [14, 3, 1, "", "biases"], [14, 2, 1, "", "build_context"], [14, 2, 1, "", "choose"], [14, 3, 1, "", "context_size"], [14, 2, 1, "", "delete"], [14, 2, 1, "", "edit"], [14, 2, 1, "", "flatten"], [14, 2, 1, "", "generate"], [14, 2, 1, "", "get_current_tree"], [14, 3, 1, "", "global_settings"], [14, 3, 1, "", "key"], [14, 3, 1, "", "keystore"], [14, 3, 1, "", "model"], [14, 3, 1, "", "prefix"], [14, 3, 1, "", "preset"], [14, 2, 1, "", "redo"], [14, 2, 1, "", "save"], [14, 3, 1, "", "story"], [14, 3, 1, "", "storycontent"], [14, 3, 1, "", "tree"], [14, 2, 1, "", "undo"]], "novelai_api.StoryHandler.NovelAIStoryStorage": [[14, 2, 1, "", "__init__"], [14, 3, 1, "", "api"], [14, 2, 1, "", "create"], [14, 3, 1, "", "global_settings"], [14, 3, 1, "", "idstore"], [14, 3, 1, "", "keystore"], [14, 2, 1, "", "load"], [14, 2, 1, "", "load_from_remote"], [14, 2, 1, "", "loads"], [14, 2, 1, "", "select"], [14, 2, 1, "", "unload"]], "novelai_api.Tokenizer": [[15, 1, 1, "", "SentencePiece"], [15, 1, 1, "", "Tokenizer"]], "novelai_api.Tokenizer.SentencePiece": [[15, 2, 1, "", "__init__"], [15, 2, 1, "", "decode"], [15, 2, 1, "", "encode"], [15, 3, 1, "", "trans_regex_str"], [15, 3, 1, "", "trans_table_ids"], [15, 3, 1, "", "trans_table_str"]], "novelai_api.Tokenizer.Tokenizer": [[15, 2, 1, "", "decode"], [15, 2, 1, "", "encode"], [15, 2, 1, "", "get_tokenizer_name"]], "novelai_api._high_level": [[16, 1, 1, "", "HighLevel"]], "novelai_api._high_level.HighLevel": [[16, 2, 1, "", "__init__"], [16, 2, 1, "", "download_user_modules"], [16, 2, 1, "", "download_user_presets"], [16, 2, 1, "", "download_user_shelves"], [16, 2, 1, "", "download_user_stories"], [16, 2, 1, "", "download_user_story_contents"], [16, 2, 1, "", "generate"], [16, 2, 1, "", "generate_image"], [16, 2, 1, "", "generate_stream"], [16, 2, 1, "", "get_keystore"], [16, 2, 1, "", "login"], [16, 2, 1, "", "login_from_token"], [16, 2, 1, "", "register"], [16, 2, 1, "", "set_keystore"], [16, 2, 1, "", "upload_user_content"], [16, 2, 1, "", "upload_user_contents"]], "novelai_api._low_level": [[17, 1, 1, "", "LowLevel"], [17, 5, 1, "", "print_with_parameters"]], "novelai_api._low_level.LowLevel": [[17, 1, 1, "", "SubscriptionTier"], [17, 2, 1, "", "__init__"], [17, 2, 1, "", "bind_subscription"], [17, 2, 1, "", "buy_steps"], [17, 2, 1, "", "change_access_key"], [17, 2, 1, "", "change_subscription"], [17, 2, 1, "", "classify"], [17, 2, 1, "", "delete_account"], [17, 2, 1, "", "delete_module"], [17, 2, 1, "", "delete_object"], [17, 2, 1, "", "download_object"], [17, 2, 1, "", "download_objects"], [17, 2, 1, "", "generate"], [17, 2, 1, "", "generate_controlnet_mask"], [17, 2, 1, "", "generate_image"], [17, 2, 1, "", "generate_prompt"], [17, 2, 1, "", "generate_voice"], [17, 2, 1, "", "get_data"], [17, 2, 1, "", "get_information"], [17, 2, 1, "", "get_keystore"], [17, 2, 1, "", "get_priority"], [17, 2, 1, "", "get_settings"], [17, 2, 1, "", "get_subscription"], [17, 2, 1, "", "get_trained_module"], [17, 2, 1, "", "get_trained_modules"], [17, 2, 1, "", "is_reachable"], [17, 3, 1, "", "is_schema_validation_enabled"], [17, 2, 1, "", "login"], [17, 2, 1, "", "recover_account"], [17, 2, 1, "", "register"], [17, 2, 1, "", "request"], [17, 2, 1, "", "request_account_recovery"], [17, 2, 1, "", "send_email_verification"], [17, 2, 1, "", "set_keystore"], [17, 2, 1, "", "set_settings"], [17, 2, 1, "", "suggest_tags"], [17, 2, 1, "", "train_module"], [17, 2, 1, "", "upload_object"], [17, 2, 1, "", "upload_objects"], [17, 2, 1, "", "upscale_image"], [17, 2, 1, "", "verify_email"]], "novelai_api._low_level.LowLevel.SubscriptionTier": [[17, 3, 1, "", "OPUS"], [17, 3, 1, "", "PAPER"], [17, 3, 1, "", "SCROLL"], [17, 3, 1, "", "TABLET"]], "novelai_api.utils": [[18, 5, 1, "", "argon_hash"], [18, 5, 1, "", "b64_to_tokens"], [18, 5, 1, "", "compress_user_data"], [18, 5, 1, "", "decompress_user_data"], [18, 5, 1, "", "decrypt_data"], [18, 5, 1, "", "decrypt_user_data"], [18, 5, 1, "", "encrypt_data"], [18, 5, 1, "", "encrypt_user_data"], [18, 5, 1, "", "extract_preset_data"], [18, 5, 1, "", "get_access_key"], [18, 5, 1, "", "get_decrypted_user_data"], [18, 5, 1, "", "get_encryption_key"], [18, 5, 1, "", "link_content_to_story"], [18, 5, 1, "", "tokenize_if_not"], [18, 5, 1, "", "tokens_to_b64"], [18, 5, 1, "", "unlink_content_from_story"]], "tests.api": [[20, 0, 0, "-", "boilerplate"], [19, 0, 0, "-", "test_decrypt_encrypt_integrity_check"], [19, 0, 0, "-", "test_imagegen_samplers"], [19, 0, 0, "-", "test_sync_gen"], [19, 0, 0, "-", "test_textgen_presets"]], "tests.api.boilerplate": [[20, 1, 1, "", "API"], [20, 1, 1, "", "JSONEncoder"], [20, 5, 1, "", "api_handle"], [20, 5, 1, "", "api_handle_sync"], [20, 5, 1, "", "dumps"], [20, 5, 1, "", "error_handler"]], "tests.api.boilerplate.API": [[20, 2, 1, "", "__init__"], [20, 3, 1, "", "api"], [20, 4, 1, "", "encryption_key"], [20, 3, 1, "", "logger"]], "tests.api.boilerplate.JSONEncoder": [[20, 2, 1, "", "default"]], "tests.api.test_decrypt_encrypt_integrity_check": [[19, 5, 1, "", "aimodules_integrity"], [19, 5, 1, "", "keystore_integrity"], [19, 5, 1, "", "presets_integrity"], [19, 5, 1, "", "shelves_integrity"], [19, 5, 1, "", "stories_integrity"], [19, 5, 1, "", "storycontent_integrity"]], "tests.api.test_textgen_presets": [[19, 5, 1, "", "preset_from_default"], [19, 5, 1, "", "preset_from_official"], [19, 5, 1, "", "test_presets"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:property", "5": "py:function", "6": "py:exception", "7": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"], "6": ["py", "exception", "Python exception"], "7": ["py", "data", "Python data"]}, "titleterms": {"exampl": [0, 2], "directori": [0, 19, 21], "requir": [0, 19], "usag": [0, 2, 19], "content": [0, 19, 21], "download_modul": 0, "py": [0, 19], "download_preset": 0, "download_shelv": 0, "download_stories_and_cont": 0, "generate_controlnet_mask": 0, "generate_imag": 0, "generate_image_test_sampl": 0, "generate_image_with_controlnet": 0, "generate_image_with_img2img": 0, "generate_text": 0, "generate_voic": 0, "login": 0, "login_with_proxi": 0, "suggest_tag": 0, "upscale_imag": 0, "refer": [0, 2, 19, 21], "boilerpl": [1, 20], "novelai": [2, 3], "api": [2, 3, 19], "us": 2, "modul": 2, "via": 2, "command": 2, "line": 2, "get": 2, "access": 2, "kei": 2, "token": [2, 15], "saniti": 2, "check": 2, "decod": 2, "your": 2, "code": 2, "low_level": [2, 17], "high_level": [2, 16], "develop": 2, "contribut": 2, "test": 2, "against": 2, "mock": [2, 21], "doc": 2, "todo": 2, "packag": 3, "novelai_api": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "banlist": 4, "biasgroup": 5, "globalset": 6, "idstor": 7, "imagepreset": 8, "keystor": 9, "novelaierror": 10, "preset": 12, "schemavalid": 13, "storyhandl": 14, "util": 18, "test_decrypt_encrypt_integrity_check": 19, "test_imagegen_sampl": 19, "test_sync_gen": 19, "test_textgen_preset": 19, "test_textgen_san": 19}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx_last_updated_by_git": 1, "sphinx": 57}, "alltitles": {"example directory": [[0, "example-directory"]], "Requirements": [[0, "requirements"], [19, "requirements"]], "Usage": [[0, "usage"], [2, "usage"], [19, "usage"]], "Content": [[0, "module-example.download_modules"], [19, "content"], [21, "content"]], "download_modules.py": [[0, "download-modules-py"]], "download_presets.py": [[0, "download-presets-py"]], "download_shelves.py": [[0, "download-shelves-py"]], "download_stories_and_content.py": [[0, "download-stories-and-content-py"]], "generate_controlnet_masks.py": [[0, "generate-controlnet-masks-py"]], "generate_image.py": [[0, "generate-image-py"]], "generate_image_test_samplers.py": [[0, "generate-image-test-samplers-py"]], "generate_image_with_controlnet.py": [[0, "generate-image-with-controlnet-py"]], "generate_image_with_img2img.py": [[0, "generate-image-with-img2img-py"]], "generate_text.py": [[0, "generate-text-py"]], "generate_voice.py": [[0, "generate-voice-py"]], "login.py": [[0, "login-py"]], "login_with_proxy.py": [[0, "login-with-proxy-py"]], "suggest_tags.py": [[0, "suggest-tags-py"]], "upscale_image.py": [[0, "upscale-image-py"]], "Reference": [[0, "reference"], [2, "reference"], [19, "reference"], [21, "reference"]], "boilerplate": [[1, "module-example.boilerplate"], [20, "module-tests.api.boilerplate"]], "novelai-api": [[2, "novelai-api"], [2, "novelai-api"]], "Using the module via Command Line": [[2, "using-the-module-via-command-line"]], "Get access key": [[2, "get-access-key"]], "Get access token": [[2, "get-access-token"]], "Sanity check": [[2, "sanity-check"]], "Decode": [[2, "decode"]], "Using the module in your code": [[2, "using-the-module-in-your-code"]], "low_level": [[2, "low-level"]], "high_level": [[2, "high-level"]], "Development": [[2, "development"]], "Contributing": [[2, "contributing"]], "Testing against the API": [[2, "testing-against-the-api"]], "Testing against the mocked API": [[2, "testing-against-the-mocked-api"]], "Docs": [[2, "docs"]], "TODO": [[2, "todo"]], "example": [[2, "example"]], "Test API": [[2, "test-api"]], "Test Mocked API": [[2, "test-mocked-api"]], "novelai-api package": [[3, "novelai-api-package"]], "novelai_api.BanList": [[4, "module-novelai_api.BanList"]], "novelai_api.BiasGroup": [[5, "module-novelai_api.BiasGroup"]], "novelai_api.GlobalSettings": [[6, "module-novelai_api.GlobalSettings"]], "novelai_api.Idstore": [[7, "module-novelai_api.Idstore"]], "novelai_api.ImagePreset": [[8, "module-novelai_api.ImagePreset"]], "novelai_api.Keystore": [[9, "module-novelai_api.Keystore"]], "novelai_api.NovelAIError": [[10, "module-novelai_api.NovelAIError"]], "novelai_api.NovelAI_API": [[11, "module-novelai_api.NovelAI_API"]], "novelai_api.Preset": [[12, "module-novelai_api.Preset"]], "novelai_api.SchemaValidator": [[13, "module-novelai_api.SchemaValidator"]], "novelai_api.StoryHandler": [[14, "module-novelai_api.StoryHandler"]], "novelai_api.Tokenizer": [[15, "module-novelai_api.Tokenizer"]], "novelai_api.high_level": [[16, "module-novelai_api._high_level"]], "novelai_api.low_level": [[17, "module-novelai_api._low_level"]], "novelai_api.utils": [[18, "module-novelai_api.utils"]], "API directory": [[19, "api-directory"]], "test_decrypt_encrypt_integrity_check.py": [[19, "module-tests.api.test_decrypt_encrypt_integrity_check"]], "test_imagegen_samplers.py": [[19, "module-tests.api.test_imagegen_samplers"]], "test_sync_gen.py": [[19, "module-tests.api.test_sync_gen"]], "test_textgen_presets.py": [[19, "module-tests.api.test_textgen_presets"]], "test_textgen_sanity.py": [[19, "test-textgen-sanity-py"]], "Mock directory": [[21, "mock-directory"]]}, "indexentries": {"example.download_modules": [[0, "module-example.download_modules"]], "example.download_presets": [[0, "module-example.download_presets"]], "example.download_shelves": [[0, "module-example.download_shelves"]], "example.download_stories_and_content": [[0, "module-example.download_stories_and_content"]], "example.generate_controlnet_masks": [[0, "module-example.generate_controlnet_masks"]], "example.generate_image": [[0, "module-example.generate_image"]], "example.generate_image_test_samplers": [[0, "module-example.generate_image_test_samplers"]], "example.generate_image_with_controlnet": [[0, "module-example.generate_image_with_controlnet"]], "example.generate_image_with_img2img": [[0, "module-example.generate_image_with_img2img"]], "example.generate_text": [[0, "module-example.generate_text"]], "example.generate_voice": [[0, "module-example.generate_voice"]], "example.login": [[0, "module-example.login"]], "example.login_with_proxy": [[0, "module-example.login_with_proxy"]], "example.suggest_tags": [[0, "module-example.suggest_tags"]], "example.upscale_image": [[0, "module-example.upscale_image"]], "module": [[0, "module-example.download_modules"], [0, "module-example.download_presets"], [0, "module-example.download_shelves"], [0, "module-example.download_stories_and_content"], [0, "module-example.generate_controlnet_masks"], [0, "module-example.generate_image"], [0, "module-example.generate_image_test_samplers"], [0, "module-example.generate_image_with_controlnet"], [0, "module-example.generate_image_with_img2img"], [0, "module-example.generate_text"], [0, "module-example.generate_voice"], [0, "module-example.login"], [0, "module-example.login_with_proxy"], [0, "module-example.suggest_tags"], [0, "module-example.upscale_image"], [1, "module-example.boilerplate"], [4, "module-novelai_api.BanList"], [5, "module-novelai_api.BiasGroup"], [6, "module-novelai_api.GlobalSettings"], [7, "module-novelai_api.Idstore"], [8, "module-novelai_api.ImagePreset"], [9, "module-novelai_api.Keystore"], [10, "module-novelai_api.NovelAIError"], [11, "module-novelai_api.NovelAI_API"], [12, "module-novelai_api.Preset"], [13, "module-novelai_api.SchemaValidator"], [14, "module-novelai_api.StoryHandler"], [15, "module-novelai_api.Tokenizer"], [16, "module-novelai_api._high_level"], [17, "module-novelai_api._low_level"], [18, "module-novelai_api.utils"], [19, "module-tests.api.test_decrypt_encrypt_integrity_check"], [19, "module-tests.api.test_imagegen_samplers"], [19, "module-tests.api.test_sync_gen"], [19, "module-tests.api.test_textgen_presets"], [20, "module-tests.api.boilerplate"]], "api (class in example.boilerplate)": [[1, "example.boilerplate.API"]], "jsonencoder (class in example.boilerplate)": [[1, "example.boilerplate.JSONEncoder"]], "__init__() (api method)": [[1, "example.boilerplate.API.__init__"], [20, "tests.api.boilerplate.API.__init__"]], "api (api attribute)": [[1, "example.boilerplate.API.api"], [20, "tests.api.boilerplate.API.api"]], "default() (jsonencoder method)": [[1, "example.boilerplate.JSONEncoder.default"], [20, "tests.api.boilerplate.JSONEncoder.default"]], "dumps() (in module example.boilerplate)": [[1, "example.boilerplate.dumps"]], "encryption_key (api property)": [[1, "example.boilerplate.API.encryption_key"], [20, "tests.api.boilerplate.API.encryption_key"]], "example.boilerplate": [[1, "module-example.boilerplate"]], "logger (api attribute)": [[1, "example.boilerplate.API.logger"], [20, "tests.api.boilerplate.API.logger"]], "banlist (class in novelai_api.banlist)": [[4, "novelai_api.BanList.BanList"]], "__init__() (banlist method)": [[4, "novelai_api.BanList.BanList.__init__"]], "add() (banlist method)": [[4, "novelai_api.BanList.BanList.add"]], "enabled (banlist attribute)": [[4, "novelai_api.BanList.BanList.enabled"]], "get_tokenized_entries() (banlist method)": [[4, "novelai_api.BanList.BanList.get_tokenized_entries"]], "novelai_api.banlist": [[4, "module-novelai_api.BanList"]], "biasgroup (class in novelai_api.biasgroup)": [[5, "novelai_api.BiasGroup.BiasGroup"]], "__init__() (biasgroup method)": [[5, "novelai_api.BiasGroup.BiasGroup.__init__"]], "add() (biasgroup method)": [[5, "novelai_api.BiasGroup.BiasGroup.add"]], "bias (biasgroup attribute)": [[5, "novelai_api.BiasGroup.BiasGroup.bias"]], "enabled (biasgroup attribute)": [[5, "novelai_api.BiasGroup.BiasGroup.enabled"]], "ensure_sequence_finish (biasgroup attribute)": [[5, "novelai_api.BiasGroup.BiasGroup.ensure_sequence_finish"]], "from_data() (biasgroup class method)": [[5, "novelai_api.BiasGroup.BiasGroup.from_data"]], "generate_once (biasgroup attribute)": [[5, "novelai_api.BiasGroup.BiasGroup.generate_once"]], "get_tokenized_entries() (biasgroup method)": [[5, "novelai_api.BiasGroup.BiasGroup.get_tokenized_entries"]], "novelai_api.biasgroup": [[5, "module-novelai_api.BiasGroup"]], "globalsettings (class in novelai_api.globalsettings)": [[6, "novelai_api.GlobalSettings.GlobalSettings"]], "no_logprobs (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.NO_LOGPROBS"]], "__init__() (globalsettings method)": [[6, "novelai_api.GlobalSettings.GlobalSettings.__init__"]], "ban_ambiguous_genji_tokens (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.ban_ambiguous_genji_tokens"]], "ban_brackets (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.ban_brackets"]], "bias_dinkus_asterism (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.bias_dinkus_asterism"]], "copy() (globalsettings method)": [[6, "novelai_api.GlobalSettings.GlobalSettings.copy"]], "generate_until_sentence (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.generate_until_sentence"]], "novelai_api.globalsettings": [[6, "module-novelai_api.GlobalSettings"]], "num_logprobs (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.num_logprobs"]], "rep_pen_whitelist (globalsettings attribute)": [[6, "novelai_api.GlobalSettings.GlobalSettings.rep_pen_whitelist"]], "to_settings() (globalsettings method)": [[6, "novelai_api.GlobalSettings.GlobalSettings.to_settings"]], "idstore (class in novelai_api.idstore)": [[7, "novelai_api.Idstore.Idstore"]], "__init__() (idstore method)": [[7, "novelai_api.Idstore.Idstore.__init__"]], "create() (idstore method)": [[7, "novelai_api.Idstore.Idstore.create"]], "novelai_api.idstore": [[7, "module-novelai_api.Idstore"]], "register() (idstore method)": [[7, "novelai_api.Idstore.Idstore.register"]], "anime_curated (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Anime_Curated"]], "anime_full (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Anime_Full"]], "building_control (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Building_Control"]], "controlnetmodel (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ControlNetModel"]], "form_lock (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Form_Lock"]], "furry (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Furry"]], "img2img (imagegenerationtype attribute)": [[8, "novelai_api.ImagePreset.ImageGenerationType.IMG2IMG"]], "inpainting (imagegenerationtype attribute)": [[8, "novelai_api.ImagePreset.ImageGenerationType.INPAINTING"]], "imagegenerationtype (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImageGenerationType"]], "imagemodel (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImageModel"]], "imagepreset (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImagePreset"]], "imageresolution (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImageResolution"]], "imagesampler (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.ImageSampler"]], "inainting_anime_curated (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Inainting_Anime_Curated"]], "inpainting_anime_full (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Inpainting_Anime_Full"]], "inpainting_furry (imagemodel attribute)": [[8, "novelai_api.ImagePreset.ImageModel.Inpainting_Furry"]], "landscaper (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Landscaper"]], "large_landscape (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Large_Landscape"]], "large_portrait (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Large_Portrait"]], "large_square (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Large_Square"]], "normal (imagegenerationtype attribute)": [[8, "novelai_api.ImagePreset.ImageGenerationType.NORMAL"]], "normal_landscape (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Normal_Landscape"]], "normal_portrait (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Normal_Portrait"]], "normal_square (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Normal_Square"]], "palette_swap (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Palette_Swap"]], "preset_bad_anatomy (ucpreset attribute)": [[8, "novelai_api.ImagePreset.UCPreset.Preset_Bad_Anatomy"]], "preset_low_quality (ucpreset attribute)": [[8, "novelai_api.ImagePreset.UCPreset.Preset_Low_Quality"]], "preset_low_quality_bad_anatomy (ucpreset attribute)": [[8, "novelai_api.ImagePreset.UCPreset.Preset_Low_Quality_Bad_Anatomy"]], "preset_none (ucpreset attribute)": [[8, "novelai_api.ImagePreset.UCPreset.Preset_None"]], "scribbler (controlnetmodel attribute)": [[8, "novelai_api.ImagePreset.ControlNetModel.Scribbler"]], "small_landscape (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Small_Landscape"]], "small_portrait (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Small_Portrait"]], "small_square (imageresolution attribute)": [[8, "novelai_api.ImagePreset.ImageResolution.Small_Square"]], "ucpreset (class in novelai_api.imagepreset)": [[8, "novelai_api.ImagePreset.UCPreset"]], "__init__() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.__init__"]], "add_original_image (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.add_original_image"]], "calculate_cost() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.calculate_cost"]], "controlnet_condition (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.controlnet_condition"]], "controlnet_model (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.controlnet_model"]], "controlnet_strength (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.controlnet_strength"]], "copy() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.copy"]], "ddim (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.ddim"]], "decrisper (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.decrisper"]], "from_file() (imagepreset class method)": [[8, "novelai_api.ImagePreset.ImagePreset.from_file"]], "get_max_n_samples() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.get_max_n_samples"]], "image (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.image"]], "k_dpm_2 (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpm_2"]], "k_dpm_2_ancestral (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpm_2_ancestral"]], "k_dpm_adaptive (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpm_adaptive"]], "k_dpm_fast (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpm_fast"]], "k_dpmpp_2m (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpmpp_2m"]], "k_dpmpp_2s_ancestral (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpmpp_2s_ancestral"]], "k_dpmpp_sde (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_dpmpp_sde"]], "k_euler (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_euler"]], "k_euler_ancestral (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_euler_ancestral"]], "k_heun (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_heun"]], "k_lms (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.k_lms"]], "last_seed (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.last_seed"]], "mask (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.mask"]], "n_samples (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.n_samples"]], "nai_smea (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.nai_smea"]], "nai_smea_dyn (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.nai_smea_dyn"]], "noise (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.noise"]], "novelai_api.imagepreset": [[8, "module-novelai_api.ImagePreset"]], "plms (imagesampler attribute)": [[8, "novelai_api.ImagePreset.ImageSampler.plms"]], "quality_toggle (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.quality_toggle"]], "resolution (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.resolution"]], "sampler (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.sampler"]], "scale (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.scale"]], "seed (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.seed"]], "smea (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.smea"]], "smea_dyn (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.smea_dyn"]], "steps (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.steps"]], "strength (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.strength"]], "to_file() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.to_file"]], "to_settings() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.to_settings"]], "uc (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.uc"]], "uc_preset (imagepreset attribute)": [[8, "novelai_api.ImagePreset.ImagePreset.uc_preset"]], "update() (imagepreset method)": [[8, "novelai_api.ImagePreset.ImagePreset.update"]], "keystore (class in novelai_api.keystore)": [[9, "novelai_api.Keystore.Keystore"]], "__init__() (keystore method)": [[9, "novelai_api.Keystore.Keystore.__init__"]], "create() (keystore method)": [[9, "novelai_api.Keystore.Keystore.create"]], "data (keystore attribute)": [[9, "novelai_api.Keystore.Keystore.data"]], "decrypt() (keystore method)": [[9, "novelai_api.Keystore.Keystore.decrypt"]], "encrypt() (keystore method)": [[9, "novelai_api.Keystore.Keystore.encrypt"]], "novelai_api.keystore": [[9, "module-novelai_api.Keystore"]], "novelaierror": [[10, "novelai_api.NovelAIError.NovelAIError"]], "__init__() (novelaierror method)": [[10, "novelai_api.NovelAIError.NovelAIError.__init__"]], "message (novelaierror attribute)": [[10, "novelai_api.NovelAIError.NovelAIError.message"]], "novelai_api.novelaierror": [[10, "module-novelai_api.NovelAIError"]], "status (novelaierror attribute)": [[10, "novelai_api.NovelAIError.NovelAIError.status"]], "url (novelaierror attribute)": [[10, "novelai_api.NovelAIError.NovelAIError.url"]], "base_address (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.BASE_ADDRESS"]], "lib_root (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.LIB_ROOT"]], "novelaiapi (class in novelai_api.novelai_api)": [[11, "novelai_api.NovelAI_API.NovelAIAPI"]], "__init__() (novelaiapi method)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.__init__"]], "attach_session() (novelaiapi method)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.attach_session"]], "cookies (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.cookies"]], "detach_session() (novelaiapi method)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.detach_session"]], "headers (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.headers"]], "high_level (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.high_level"]], "logger (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.logger"]], "low_level (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.low_level"]], "novelai_api.novelai_api": [[11, "module-novelai_api.NovelAI_API"]], "proxy (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.proxy"]], "proxy_auth (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.proxy_auth"]], "session (novelaiapi attribute)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.session"]], "timeout (novelaiapi property)": [[11, "novelai_api.NovelAI_API.NovelAIAPI.timeout"]], "aggressive (phrasereppen attribute)": [[12, "novelai_api.Preset.PhraseRepPen.Aggressive"]], "cfg (order attribute)": [[12, "novelai_api.Preset.Order.CFG"]], "clio (model attribute)": [[12, "novelai_api.Preset.Model.Clio"]], "defaults (preset attribute)": [[12, "novelai_api.Preset.Preset.DEFAULTS"]], "euterpe (model attribute)": [[12, "novelai_api.Preset.Model.Euterpe"]], "genji (model attribute)": [[12, "novelai_api.Preset.Model.Genji"]], "hypebot (model attribute)": [[12, "novelai_api.Preset.Model.HypeBot"]], "inline (model attribute)": [[12, "novelai_api.Preset.Model.Inline"]], "kayra (model attribute)": [[12, "novelai_api.Preset.Model.Kayra"]], "krake (model attribute)": [[12, "novelai_api.Preset.Model.Krake"]], "light (phrasereppen attribute)": [[12, "novelai_api.Preset.PhraseRepPen.Light"]], "medium (phrasereppen attribute)": [[12, "novelai_api.Preset.PhraseRepPen.Medium"]], "model (class in novelai_api.preset)": [[12, "novelai_api.Preset.Model"]], "off (phrasereppen attribute)": [[12, "novelai_api.Preset.PhraseRepPen.Off"]], "order (class in novelai_api.preset)": [[12, "novelai_api.Preset.Order"]], "preamble (in module novelai_api.preset)": [[12, "novelai_api.Preset.PREAMBLE"]], "phrasereppen (class in novelai_api.preset)": [[12, "novelai_api.Preset.PhraseRepPen"]], "preset (class in novelai_api.preset)": [[12, "novelai_api.Preset.Preset"]], "presetview (class in novelai_api.preset)": [[12, "novelai_api.Preset.PresetView"]], "sigurd (model attribute)": [[12, "novelai_api.Preset.Model.Sigurd"]], "snek (model attribute)": [[12, "novelai_api.Preset.Model.Snek"]], "strenum (class in novelai_api.preset)": [[12, "novelai_api.Preset.StrEnum"]], "tfs (order attribute)": [[12, "novelai_api.Preset.Order.TFS"]], "temperature (order attribute)": [[12, "novelai_api.Preset.Order.Temperature"]], "top_a (order attribute)": [[12, "novelai_api.Preset.Order.Top_A"]], "top_k (order attribute)": [[12, "novelai_api.Preset.Order.Top_K"]], "top_p (order attribute)": [[12, "novelai_api.Preset.Order.Top_P"]], "typical_p (order attribute)": [[12, "novelai_api.Preset.Order.Typical_P"]], "veryaggressive (phrasereppen attribute)": [[12, "novelai_api.Preset.PhraseRepPen.VeryAggressive"]], "verylight (phrasereppen attribute)": [[12, "novelai_api.Preset.PhraseRepPen.VeryLight"]], "__init__() (preset method)": [[12, "novelai_api.Preset.Preset.__init__"]], "__init__() (presetview method)": [[12, "novelai_api.Preset.PresetView.__init__"]], "bos_token_id (preset attribute)": [[12, "novelai_api.Preset.Preset.bos_token_id"]], "cfg_scale (preset attribute)": [[12, "novelai_api.Preset.Preset.cfg_scale"]], "cfg_uc (preset attribute)": [[12, "novelai_api.Preset.Preset.cfg_uc"]], "collapse_model() (in module novelai_api.preset)": [[12, "novelai_api.Preset.collapse_model"]], "copy() (preset method)": [[12, "novelai_api.Preset.Preset.copy"]], "diversity_penalty (preset attribute)": [[12, "novelai_api.Preset.Preset.diversity_penalty"]], "enable() (preset method)": [[12, "novelai_api.Preset.Preset.enable"]], "encoder_no_repeat_ngram_size (preset attribute)": [[12, "novelai_api.Preset.Preset.encoder_no_repeat_ngram_size"]], "enum_contains() (in module novelai_api.preset)": [[12, "novelai_api.Preset.enum_contains"]], "enum_member_values (model attribute)": [[12, "novelai_api.Preset.Model.enum_member_values"]], "eos_token_id (preset attribute)": [[12, "novelai_api.Preset.Preset.eos_token_id"]], "from_default() (preset class method)": [[12, "novelai_api.Preset.Preset.from_default"]], "from_file() (preset class method)": [[12, "novelai_api.Preset.Preset.from_file"]], "from_official() (preset class method)": [[12, "novelai_api.Preset.Preset.from_official"]], "from_preset_data() (preset class method)": [[12, "novelai_api.Preset.Preset.from_preset_data"]], "get_hidden_states (preset attribute)": [[12, "novelai_api.Preset.Preset.get_hidden_states"]], "length_penalty (preset attribute)": [[12, "novelai_api.Preset.Preset.length_penalty"]], "max_length (preset attribute)": [[12, "novelai_api.Preset.Preset.max_length"]], "max_time (preset attribute)": [[12, "novelai_api.Preset.Preset.max_time"]], "min_length (preset attribute)": [[12, "novelai_api.Preset.Preset.min_length"]], "model (preset attribute)": [[12, "novelai_api.Preset.Preset.model"]], "model (presetview attribute)": [[12, "novelai_api.Preset.PresetView.model"]], "name (preset attribute)": [[12, "novelai_api.Preset.Preset.name"]], "no_repeat_ngram_size (preset attribute)": [[12, "novelai_api.Preset.Preset.no_repeat_ngram_size"]], "novelai_api.preset": [[12, "module-novelai_api.Preset"]], "num_return_sequences (preset attribute)": [[12, "novelai_api.Preset.Preset.num_return_sequences"]], "order (preset attribute)": [[12, "novelai_api.Preset.Preset.order"]], "pad_token_id (preset attribute)": [[12, "novelai_api.Preset.Preset.pad_token_id"]], "phrase_rep_pen (preset attribute)": [[12, "novelai_api.Preset.Preset.phrase_rep_pen"]], "repetition_penalty (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty"]], "repetition_penalty_default_whitelist (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_default_whitelist"]], "repetition_penalty_frequency (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_frequency"]], "repetition_penalty_presence (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_presence"]], "repetition_penalty_range (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_range"]], "repetition_penalty_slope (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_slope"]], "repetition_penalty_whitelist (preset attribute)": [[12, "novelai_api.Preset.Preset.repetition_penalty_whitelist"]], "set() (preset method)": [[12, "novelai_api.Preset.Preset.set"]], "tail_free_sampling (preset attribute)": [[12, "novelai_api.Preset.Preset.tail_free_sampling"]], "temperature (preset attribute)": [[12, "novelai_api.Preset.Preset.temperature"]], "textgenerationsettingsversion (preset attribute)": [[12, "novelai_api.Preset.Preset.textGenerationSettingsVersion"]], "to_file() (preset method)": [[12, "novelai_api.Preset.Preset.to_file"]], "to_settings() (preset method)": [[12, "novelai_api.Preset.Preset.to_settings"]], "top_a (preset attribute)": [[12, "novelai_api.Preset.Preset.top_a"]], "top_k (preset attribute)": [[12, "novelai_api.Preset.Preset.top_k"]], "top_p (preset attribute)": [[12, "novelai_api.Preset.Preset.top_p"]], "typical_p (preset attribute)": [[12, "novelai_api.Preset.Preset.typical_p"]], "update() (preset method)": [[12, "novelai_api.Preset.Preset.update"]], "schemavalidator (class in novelai_api.schemavalidator)": [[13, "novelai_api.SchemaValidator.SchemaValidator"]], "__init__() (schemavalidator method)": [[13, "novelai_api.SchemaValidator.SchemaValidator.__init__"]], "novelai_api.schemavalidator": [[13, "module-novelai_api.SchemaValidator"]], "validate() (schemavalidator class method)": [[13, "novelai_api.SchemaValidator.SchemaValidator.validate"]], "default_model (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.DEFAULT_MODEL"]], "novelaistory (class in novelai_api.storyhandler)": [[14, "novelai_api.StoryHandler.NovelAIStory"]], "novelaistorystorage (class in novelai_api.storyhandler)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage"]], "text_generation_settings_version (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.TEXT_GENERATION_SETTINGS_VERSION"]], "__init__() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.__init__"]], "__init__() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.__init__"]], "api (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.api"]], "api (novelaistorystorage attribute)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.api"]], "banlists (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.banlists"]], "biases (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.biases"]], "build_context() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.build_context"]], "choose() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.choose"]], "context_size (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.context_size"]], "create() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.create"]], "delete() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.delete"]], "edit() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.edit"]], "flatten() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.flatten"]], "generate() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.generate"]], "get_current_tree() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.get_current_tree"]], "global_settings (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.global_settings"]], "global_settings (novelaistorystorage attribute)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.global_settings"]], "idstore (novelaistorystorage attribute)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.idstore"]], "key (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.key"]], "keystore (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.keystore"]], "keystore (novelaistorystorage attribute)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.keystore"]], "load() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.load"]], "load_from_remote() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.load_from_remote"]], "loads() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.loads"]], "model (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.model"]], "novelai_api.storyhandler": [[14, "module-novelai_api.StoryHandler"]], "prefix (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.prefix"]], "preset (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.preset"]], "redo() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.redo"]], "save() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.save"]], "select() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.select"]], "story (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.story"]], "storycontent (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.storycontent"]], "tree (novelaistory attribute)": [[14, "novelai_api.StoryHandler.NovelAIStory.tree"]], "undo() (novelaistory method)": [[14, "novelai_api.StoryHandler.NovelAIStory.undo"]], "unload() (novelaistorystorage method)": [[14, "novelai_api.StoryHandler.NovelAIStoryStorage.unload"]], "sentencepiece (class in novelai_api.tokenizer)": [[15, "novelai_api.Tokenizer.SentencePiece"]], "tokenizer (class in novelai_api.tokenizer)": [[15, "novelai_api.Tokenizer.Tokenizer"]], "__init__() (sentencepiece method)": [[15, "novelai_api.Tokenizer.SentencePiece.__init__"]], "decode() (sentencepiece method)": [[15, "novelai_api.Tokenizer.SentencePiece.decode"]], "decode() (tokenizer class method)": [[15, "novelai_api.Tokenizer.Tokenizer.decode"]], "encode() (sentencepiece method)": [[15, "novelai_api.Tokenizer.SentencePiece.encode"]], "encode() (tokenizer class method)": [[15, "novelai_api.Tokenizer.Tokenizer.encode"]], "get_tokenizer_name() (tokenizer class method)": [[15, "novelai_api.Tokenizer.Tokenizer.get_tokenizer_name"]], "novelai_api.tokenizer": [[15, "module-novelai_api.Tokenizer"]], "trans_regex_str (sentencepiece attribute)": [[15, "novelai_api.Tokenizer.SentencePiece.trans_regex_str"]], "trans_table_ids (sentencepiece attribute)": [[15, "novelai_api.Tokenizer.SentencePiece.trans_table_ids"]], "trans_table_str (sentencepiece attribute)": [[15, "novelai_api.Tokenizer.SentencePiece.trans_table_str"]], "highlevel (class in novelai_api._high_level)": [[16, "novelai_api._high_level.HighLevel"]], "__init__() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.__init__"]], "download_user_modules() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_modules"]], "download_user_presets() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_presets"]], "download_user_shelves() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_shelves"]], "download_user_stories() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_stories"]], "download_user_story_contents() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.download_user_story_contents"]], "generate() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.generate"]], "generate_image() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.generate_image"]], "generate_stream() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.generate_stream"]], "get_keystore() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.get_keystore"]], "login() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.login"]], "login_from_token() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.login_from_token"]], "novelai_api._high_level": [[16, "module-novelai_api._high_level"]], "register() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.register"]], "set_keystore() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.set_keystore"]], "upload_user_content() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.upload_user_content"]], "upload_user_contents() (highlevel method)": [[16, "novelai_api._high_level.HighLevel.upload_user_contents"]], "lowlevel (class in novelai_api._low_level)": [[17, "novelai_api._low_level.LowLevel"]], "lowlevel.subscriptiontier (class in novelai_api._low_level)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier"]], "opus (lowlevel.subscriptiontier attribute)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier.OPUS"]], "paper (lowlevel.subscriptiontier attribute)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier.PAPER"]], "scroll (lowlevel.subscriptiontier attribute)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier.SCROLL"]], "tablet (lowlevel.subscriptiontier attribute)": [[17, "novelai_api._low_level.LowLevel.SubscriptionTier.TABLET"]], "__init__() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.__init__"]], "bind_subscription() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.bind_subscription"]], "buy_steps() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.buy_steps"]], "change_access_key() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.change_access_key"]], "change_subscription() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.change_subscription"]], "classify() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.classify"]], "delete_account() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.delete_account"]], "delete_module() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.delete_module"]], "delete_object() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.delete_object"]], "download_object() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.download_object"]], "download_objects() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.download_objects"]], "generate() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate"]], "generate_controlnet_mask() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate_controlnet_mask"]], "generate_image() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate_image"]], "generate_prompt() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate_prompt"]], "generate_voice() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.generate_voice"]], "get_data() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_data"]], "get_information() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_information"]], "get_keystore() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_keystore"]], "get_priority() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_priority"]], "get_settings() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_settings"]], "get_subscription() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_subscription"]], "get_trained_module() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_trained_module"]], "get_trained_modules() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.get_trained_modules"]], "is_reachable() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.is_reachable"]], "is_schema_validation_enabled (lowlevel attribute)": [[17, "novelai_api._low_level.LowLevel.is_schema_validation_enabled"]], "login() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.login"]], "novelai_api._low_level": [[17, "module-novelai_api._low_level"]], "print_with_parameters() (in module novelai_api._low_level)": [[17, "novelai_api._low_level.print_with_parameters"]], "recover_account() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.recover_account"]], "register() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.register"]], "request() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.request"]], "request_account_recovery() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.request_account_recovery"]], "send_email_verification() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.send_email_verification"]], "set_keystore() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.set_keystore"]], "set_settings() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.set_settings"]], "suggest_tags() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.suggest_tags"]], "train_module() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.train_module"]], "upload_object() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.upload_object"]], "upload_objects() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.upload_objects"]], "upscale_image() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.upscale_image"]], "verify_email() (lowlevel method)": [[17, "novelai_api._low_level.LowLevel.verify_email"]], "argon_hash() (in module novelai_api.utils)": [[18, "novelai_api.utils.argon_hash"]], "b64_to_tokens() (in module novelai_api.utils)": [[18, "novelai_api.utils.b64_to_tokens"]], "compress_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.compress_user_data"]], "decompress_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.decompress_user_data"]], "decrypt_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.decrypt_data"]], "decrypt_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.decrypt_user_data"]], "encrypt_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.encrypt_data"]], "encrypt_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.encrypt_user_data"]], "extract_preset_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.extract_preset_data"]], "get_access_key() (in module novelai_api.utils)": [[18, "novelai_api.utils.get_access_key"]], "get_decrypted_user_data() (in module novelai_api.utils)": [[18, "novelai_api.utils.get_decrypted_user_data"]], "get_encryption_key() (in module novelai_api.utils)": [[18, "novelai_api.utils.get_encryption_key"]], "link_content_to_story() (in module novelai_api.utils)": [[18, "novelai_api.utils.link_content_to_story"]], "novelai_api.utils": [[18, "module-novelai_api.utils"]], "tokenize_if_not() (in module novelai_api.utils)": [[18, "novelai_api.utils.tokenize_if_not"]], "tokens_to_b64() (in module novelai_api.utils)": [[18, "novelai_api.utils.tokens_to_b64"]], "unlink_content_from_story() (in module novelai_api.utils)": [[18, "novelai_api.utils.unlink_content_from_story"]], "aimodules_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.aimodules_integrity"]], "keystore_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.keystore_integrity"]], "preset_from_default() (in module tests.api.test_textgen_presets)": [[19, "tests.api.test_textgen_presets.preset_from_default"]], "preset_from_official() (in module tests.api.test_textgen_presets)": [[19, "tests.api.test_textgen_presets.preset_from_official"]], "presets_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.presets_integrity"]], "shelves_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.shelves_integrity"]], "stories_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.stories_integrity"]], "storycontent_integrity() (in module tests.api.test_decrypt_encrypt_integrity_check)": [[19, "tests.api.test_decrypt_encrypt_integrity_check.storycontent_integrity"]], "test_presets() (in module tests.api.test_textgen_presets)": [[19, "tests.api.test_textgen_presets.test_presets"]], "tests.api.test_decrypt_encrypt_integrity_check": [[19, "module-tests.api.test_decrypt_encrypt_integrity_check"]], "tests.api.test_imagegen_samplers": [[19, "module-tests.api.test_imagegen_samplers"]], "tests.api.test_sync_gen": [[19, "module-tests.api.test_sync_gen"]], "tests.api.test_textgen_presets": [[19, "module-tests.api.test_textgen_presets"]], "api (class in tests.api.boilerplate)": [[20, "tests.api.boilerplate.API"]], "jsonencoder (class in tests.api.boilerplate)": [[20, "tests.api.boilerplate.JSONEncoder"]], "api_handle() (in module tests.api.boilerplate)": [[20, "tests.api.boilerplate.api_handle"]], "api_handle_sync() (in module tests.api.boilerplate)": [[20, "tests.api.boilerplate.api_handle_sync"]], "dumps() (in module tests.api.boilerplate)": [[20, "tests.api.boilerplate.dumps"]], "error_handler() (in module tests.api.boilerplate)": [[20, "tests.api.boilerplate.error_handler"]], "tests.api.boilerplate": [[20, "module-tests.api.boilerplate"]]}}) \ No newline at end of file diff --git a/tests/api/api.boilerplate.html b/tests/api/api.boilerplate.html index 82fe41c..5fe122f 100644 --- a/tests/api/api.boilerplate.html +++ b/tests/api/api.boilerplate.html @@ -6,7 +6,7 @@ - boilerplate — NovelAI API 0.17.0 documentation + boilerplate — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -216,7 +216,7 @@

    Navigation

  • previous |
  • - + diff --git a/tests/api/api.html b/tests/api/api.html index b41bcca..b29a43d 100644 --- a/tests/api/api.html +++ b/tests/api/api.html @@ -6,7 +6,7 @@ - API directory — NovelAI API 0.17.0 documentation + API directory — NovelAI API 0.18.0 documentation @@ -52,7 +52,7 @@

    Navigation

  • previous |
  • - + @@ -273,7 +273,7 @@

    Navigation

  • previous |
  • - + diff --git a/tests/mock/mock.html b/tests/mock/mock.html index f264d51..93ef32b 100644 --- a/tests/mock/mock.html +++ b/tests/mock/mock.html @@ -6,7 +6,7 @@ - Mock directory — NovelAI API 0.17.0 documentation + Mock directory — NovelAI API 0.18.0 documentation @@ -48,7 +48,7 @@

    Navigation

  • previous |
  • - + @@ -124,7 +124,7 @@

    Navigation

  • previous |
  • - +