[DOCS] Update docs with the full list of modules

docs/source/novelai_api/Full_list_of_modules.md

@@ -0,0 +1,82 @@
+Calliope, Snek, and Genji have no module support. Modules without an attributed model are not supposed to work.
+"special_openings" is a module spcifically trained to replace the previously used preamble. It is used at the beginning of the story, under certain conditions.
+
+<br/>
+
+Name | API id | Model
+---|---|---
+No module | vanilla | All
+Special: Text Adventure | theme_textadventure | All
+||
+General: Instruct (Experimental) | special_instruct | Clio, Kayra
+General: Prose Augmenter | special_proseaugmenter | Clio, Kayra
+\-| special_openings | Clio, Kayra
+||
+General: Cross-Genre | general_crossgenre | Sigurd, Euterpe, Krake
+Special: Text Adventure | theme_textadventure | Sigurd, Euterpe, Krake
+Style: Algernon Blackwood | style_algernonblackwood | Sigurd, Euterpe, Krake
+Style: Arthur Conan Doyle | style_arthurconandoyle | Sigurd, Euterpe, Krake
+Style: Edgar Allan Poe | style_edgarallanpoe | Sigurd, Euterpe, Krake
+Style: H.P. Lovecraft | style_hplovecraft | Sigurd, Euterpe, Krake
+Style: Sheridan Le Fanu | style_shridanlefanu | Sigurd, Euterpe, Krake
+Style: Jane Austen | style_janeausten | -
+Style: Jules Verne | style_julesverne | Sigurd, Euterpe, Krake
+Style: William Shakespeare | style_williamshakespeare | -
+Theme: 19th Century Romance | theme_19thcenturyromance | Sigurd, Euterpe, Krake
+Theme: Action Archeology | theme_actionarcheology | Sigurd, Euterpe, Krake
+Theme: Artificial Intelligence | theme_ai | Sigurd, Euterpe, Krake
+Theme: Ancient China | theme_ancientchina | -
+Theme: Ancient Greece | theme_ancientgreek | -
+Theme: Ancient India | theme_india | -
+Theme: Animal Fiction | theme_animalfiction | Sigurd, Euterpe, Krake
+Theme: Anthropomorphic Animals | theme_anthropomorphicanimals | -
+Theme: Children's Fiction | theme_childrens | Sigurd, Euterpe, Krake
+Theme: Christmas | theme_christmas | Sigurd, Euterpe, Krake
+Theme: Comedic Fantasy | theme_comedicfantasy | Sigurd, Euterpe, Krake
+Theme: Contemporary | theme_contemporary | -
+Theme: Cyberpunk | theme_cyberpunk | Sigurd, Euterpe, Krake
+Theme: Dark Fantasy | theme_darkfantasy | Sigurd, Euterpe, Krake
+Theme: Dragons | theme_dragons | Sigurd, Euterpe, Krake
+Theme: Egypt | theme_egypt | Sigurd, Euterpe, Krake
+Theme: Feudal Japan | theme_feudaljapan | Sigurd, Euterpe, Krake
+Theme: Gaming | theme_gaming | -
+Theme: General Fantasy | theme_generalfantasy | Sigurd, Euterpe, Krake
+Theme: Golden Age Scifi | theme_goldenagescifi | -
+Theme: Hard SF | theme_hardsf | -
+Theme: History | theme_history | Sigurd, Euterpe, Krake
+Theme: Horror | theme_horror | Sigurd, Euterpe, Krake
+Theme: Hunter Gatherer | theme_huntergatherer | Sigurd, Euterpe, Krake
+Theme: LitRPG | theme_litrpg | Sigurd, Euterpe, Krake
+Theme: Magic Academy | theme_magicacademy | Sigurd, Euterpe, Krake
+Theme: Magic Library | theme_libraries | Sigurd, Euterpe, Krake
+Theme: Light Novels | theme_lightnovels | -
+Theme: Mars Colonization | theme_mars | Sigurd, Euterpe, Krake
+Theme: Medieval | theme_medieval | Sigurd, Euterpe, Krake
+Theme: Military SciFi | theme_militaryscifi | Sigurd, Euterpe, Krake
+Theme: Music | theme_music | -
+Theme: Mystery | theme_mystery | Sigurd, Euterpe, Krake
+Theme: Nature | theme_nature | -
+Theme: Naval Age of Discovery | theme_naval | Sigurd, Euterpe, Krake
+Theme: Noir | theme_noir | -
+Theme: Philosophy | theme_philosophy | Sigurd, Euterpe, Krake
+Theme: Pirates | theme_pirates | Sigurd, Euterpe, Krake
+Theme: Poetic Fantasy | theme_poeticfantasy | Sigurd, Euterpe, Krake
+Theme: Post-Apocalyptic | theme_postapocalyptic | Sigurd, Euterpe, Krake
+Theme: Rats | theme_rats | Sigurd, Euterpe, Krake
+Theme: Roman Empire | theme_romanempire | Sigurd, Euterpe, Krake
+Theme: Science Fantasy | theme_sciencefantasy | Sigurd, Euterpe, Krake
+Theme: Space Opera | theme_spaceopera | Sigurd, Euterpe, Krake
+Theme: Superheroes | theme_superheroes | Sigurd, Euterpe, Krake
+Theme: Steampunk | theme_airships | Sigurd, Euterpe, Krake
+Theme: Travel | theme_travel | Sigurd, Euterpe, Krake
+Theme: Urban Fantasy | theme_urbanfantasy | Sigurd, Euterpe, Krake
+Theme: Valentines | theme_valentines | Sigurd, Euterpe, Krake
+Theme: Vikings | theme_vikings | Sigurd, Euterpe, Krake
+Theme: Weird West | theme_weirdwest | -
+Theme: Western Romance | theme_westernromance | Sigurd, Euterpe, Krake
+Inspiration: Crab, Snail, and Monkey | inspiration_crabsnailandmonkey | Sigurd, Euterpe, Krake
+Inspiration: Mercantile Wolfgirl Romance | inspiration_mercantilewolfgirlromance | Sigurd, Euterpe, Krake
+Inspiration: Nervegear | inspiration_nervegear | Sigurd, Euterpe, Krake
+Inspiration: Romance of the Three Kingdoms | theme_romanceofthreekingdoms | Sigurd, Euterpe, Krake
+Inspiration: Throne Wars | inspiration_thronewars | Sigurd, Euterpe, Krake
+Inspiration: Witch at Level Cap | inspiration_witchatlevelcap | Sigurd, Euterpe, Krake

docs/source/novelai_api/novelai_api.high_level.rst

@@ -5,3 +5,10 @@ novelai\_api.high\_level
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. _list-of-modules:
+
+List of modules
+---------------
+.. include:: Full_list_of_modules.md
+   :parser: myst_parser.sphinx_

example/generate_text.py

@@ -84,6 +84,7 @@ async def main():
         # NOTE: no module
         module = None
         # NOTE: Official module - CrossGenre module (module names can be found in the network tab)
+        #       A full list can be found [here](docs/source/novelai_api/Full_list_of_modules.md)
         # module = "general_crossgenre"
         # NOTE: Custom module (Sage's Mass Effect v2) - ids can be retrieved from download_user_modules() or a scenario
         # module = "6B-v4:c6021aaa523e2dcb8588848b5fd4e2516dd4bb7107268aaa6050b5430c3a4b47:"

novelai_api/_high_level.py

@@ -272,7 +272,7 @@ async def _generate(
         :param global_settings: Global settings (used for generation)
         :param bad_words: Tokens to ban for this generation
         :param biases: Tokens to bias (up or down) for this generation
-        :param prefix: Module to use for this generation
+        :param prefix: Module to use for this generation (see :ref:`list of modules <list-of-modules>`)
         :param stream: Use data streaming for the response
         :param kwargs: Additional parameters to pass to the requests. Can also be used to overwrite existing parameters
 
@@ -359,7 +359,7 @@ async def generate(
         :param global_settings: Global settings (used for generation)
         :param bad_words: Tokens to ban for this generation
         :param biases: Tokens to bias (up or down) for this generation
-        :param prefix: Module to use for this generation
+        :param prefix: Module to use for this generation (see :ref:`list of modules <list-of-modules>`)
         :param kwargs: Additional parameters to pass to the requests. Can also be used to overwrite existing parameters
 
         :return: Content that has been generated
@@ -402,7 +402,7 @@ async def generate_stream(
         :param global_settings: Global settings (used for generation)
         :param bad_words: Tokens to ban for this generation
         :param biases: Tokens to bias (up or down) for this generation
-        :param prefix: Module to use for this generation
+        :param prefix: Module to use for this generation (see :ref:`list of modules <list-of-modules>`)
         :param kwargs: Additional parameters to pass to the requests. Can also be used to overwrite existing parameters
 
         :return: Content that has been generated