novelai-python 0.6.0__tar.gz → 0.7.0__tar.gz

{novelai_python-0.6.0 → novelai_python-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: novelai-python
-Version: 0.6.0
+Version: 0.7.0
 Summary: NovelAI Python Binding With Pydantic
 Author-Email: sudoskys <coldlando@hotmail.com>
 License: Apache License 2.0
@@ -41,47 +41,30 @@ Description-Content-Type: text/markdown
 ---
 
 [![PyPI version](https://badge.fury.io/py/novelai-python.svg)](https://badge.fury.io/py/novelai-python)
-[![Downloads](https://static.pepy.tech/badge/novelai_python)](https://static.pepy.tech/project/novelai_python)
+[![Downloads](https://pepy.tech/badge/novelai_python)](https://pepy.tech/project/novelai_python)
 
 ✨ NovelAI api python sdk with Pydantic, modern and user-friendly.
 
-The goal of this repository is to use Pydantic to build legitimate requests to access the NovelAI API service.
+The goal of this repository is to use Pydantic to build legitimate requests to access
+the [NovelAI API service](https://api.novelai.net/docs).
 
 > Python >= 3.9 is required.
 
-### Roadmap 🚧
+### 📰 News
 
-- [x] tool.random_prompt
-- [x] tool.paint_mask
-- [x] tool.image_metadata
-- [x] tokenizer
-- [x] /ai/generate-image
-- [x] /user/subscription
-- [x] /user/login
-- [x] /user/information
-- [x] /ai/upscale
-- [x] /ai/generate-image/suggest-tags
-- [x] /ai/generate-voice
-- [x] /ai/generate-stream
-- [x] /ai/generate
-- [x] /ai/augment-image
-- [ ] /ai/annotate-image
-- [ ] /ai/classify
-- [ ] /ai/generate-prompt
-
-> GenerateImageInfer.calculate_cost is correct in most cases, but please request account information to get accurate
-> consumption information.
-
-> This repo is maintained by me personally now. If you have any questions, please feel free to open an issue.
+- [Image Generation Model Release — NovelAI Anime Diffusion V4 Curated Preview (EN)](https://blog.novelai.net/release-novelai-anime-diffusion-v4-curated-preview-en-ca4b0b11e671)
+- [Tutorial: Creating Consistent Characters with NovelAI Diffusion Anime [Female]](https://blog.novelai.net/tutorial-en-creating-consistent-characters-with-novelai-diffusion-anime-female-538b4b678a4e)
 
-### Usage 🖥️
+### 📦 Usage
 
 ```shell
 pip -U install novelai-python
 ```
 
-More examples can be found in the [playground](https://github.com/LlmKira/novelai-python/tree/main/playground)
-directory, read code as documentation.
+All API users must adhere to the NovelAI Terms of Service: https://novelai.net/terms.
+
+**More examples can be found in the [playground](https://github.com/LlmKira/novelai-python/tree/main/playground)
+directory, read code as documentation.**
 
 ```python
 import asyncio
@@ -96,6 +79,7 @@ from novelai_python.sdk.ai.generate_image.schema import PositionMap
 
 load_dotenv()
 session = ApiCredential(api_token=SecretStr(os.getenv("NOVELAI_JWT")))  # pst-***
+# For security reasons, storing user credentials in plaintext is strongly discouraged.
 
 prompt = "1girl, year 2023,dynamic angle,  best quality, amazing quality, very aesthetic, absurdres"
 
@@ -126,7 +110,7 @@ async def main():
     )
     cost = gen.calculate_cost(is_opus=True)
     print(f"charge: {cost} if you are vip3")
-    resp = gen.request(session=session)
+    resp = await gen.request(session=session)
     resp: ImageGenerateResp
     print(resp.meta)
     file = resp.files[0]
@@ -139,7 +123,7 @@ loop.run_until_complete(main())
 
 ```
 
-#### LLM
+#### 📦 LLM
 
 ```python
 import asyncio
@@ -190,29 +174,38 @@ loop = asyncio.get_event_loop()
 loop.run_until_complete(chat("Hello"))
 ```
 
-#### Random Prompt
+#### 📦 Random Prompt
 
 ```python
 from novelai_python.tool.random_prompt import RandomPromptGenerator
 
-prompt = RandomPromptGenerator(nsfw_enabled=False).random_prompt()
-print(prompt)
+generator = RandomPromptGenerator()
+for i in range(10):
+    print(generator.generate_common_tags(nsfw=False))
+    print(generator.generate_scene_tags())
+    print(generator.generate_scene_composition())
+    print(generator.get_holiday_themed_tags())
 ```
 
-#### Run A Server
+#### 📦 Run A Server
 
 ```shell
 pip install novelai_python
 python3 -m novelai_python.server -h '127.0.0.1' -p 7888
 ```
 
-#### Tokenizer
+#### 📦 Tokenizer
 
 ```python
-from novelai_python._enum import get_tokenizer_model, TextLLMModel
+from novelai_python._enum import get_tokenizer_model, TextLLMModel, TextTokenizerGroup
 from novelai_python.tokenizer import NaiTokenizer
 
+# Through llm model name to get the tokenizer
 tokenizer_package = NaiTokenizer(get_tokenizer_model(TextLLMModel.ERATO))
+# Directly use the tokenizer
+clip_tokenizer = NaiTokenizer(TextTokenizerGroup.CLIP)
+
+# Tokenize a text
 t_text = "a fox jumped over the lazy dog"
 encode_tokens = tokenizer_package.encode(t_text)
 print(tokenizer_package.tokenize_text(t_text))
@@ -221,7 +214,32 @@ print(tokenizer_package.decode(tokenizer_package.encode(t_text)))
 
 ```
 
-## About Nsfw 🚫
+### 🔨 Roadmap
+
+- [x] tool.random_prompt
+- [x] tool.paint_mask
+- [x] tool.image_metadata
+- [x] tokenizer
+- [x] /ai/generate-image
+- [x] /user/subscription
+- [x] /user/login
+- [x] /user/information
+- [x] /ai/upscale
+- [x] /ai/generate-image/suggest-tags
+- [x] /ai/generate-voice
+- [x] /ai/generate-stream
+- [x] /ai/generate
+- [x] /ai/augment-image
+- [ ] /ai/annotate-image
+- [ ] /ai/classify
+- [ ] /ai/generate-prompt
+
+> GenerateImageInfer.calculate_cost is correct in most cases, but please request account information to get accurate
+> consumption information.
+
+> This repo is maintained by me personally now. If you have any questions, please feel free to open an issue.
+
+## 🚫 About Nsfw
 
 You might need some solutions for identifying NSFW content and adding a mosaic to prevent operational mishaps.
 
@@ -229,9 +247,7 @@ https://dghs-imgutils.deepghs.org/main/api_doc/detect/nudenet.html
 
 https://dghs-imgutils.deepghs.org/main/api_doc/operate/censor.html
 
-## Acknowledgements 🙏
-
-[BackEnd](https://api.novelai.net/docs)
+## 🙏 Acknowledgements
 
 [novelai-api](https://github.com/Aedial/novelai-api)
 

{novelai_python-0.6.0 → novelai_python-0.7.0}/README.md

@@ -3,47 +3,30 @@
 ---
 
 [![PyPI version](https://badge.fury.io/py/novelai-python.svg)](https://badge.fury.io/py/novelai-python)
-[![Downloads](https://static.pepy.tech/badge/novelai_python)](https://static.pepy.tech/project/novelai_python)
+[![Downloads](https://pepy.tech/badge/novelai_python)](https://pepy.tech/project/novelai_python)
 
 ✨ NovelAI api python sdk with Pydantic, modern and user-friendly.
 
-The goal of this repository is to use Pydantic to build legitimate requests to access the NovelAI API service.
+The goal of this repository is to use Pydantic to build legitimate requests to access
+the [NovelAI API service](https://api.novelai.net/docs).
 
 > Python >= 3.9 is required.
 
-### Roadmap 🚧
+### 📰 News
 
-- [x] tool.random_prompt
-- [x] tool.paint_mask
-- [x] tool.image_metadata
-- [x] tokenizer
-- [x] /ai/generate-image
-- [x] /user/subscription
-- [x] /user/login
-- [x] /user/information
-- [x] /ai/upscale
-- [x] /ai/generate-image/suggest-tags
-- [x] /ai/generate-voice
-- [x] /ai/generate-stream
-- [x] /ai/generate
-- [x] /ai/augment-image
-- [ ] /ai/annotate-image
-- [ ] /ai/classify
-- [ ] /ai/generate-prompt
-
-> GenerateImageInfer.calculate_cost is correct in most cases, but please request account information to get accurate
-> consumption information.
-
-> This repo is maintained by me personally now. If you have any questions, please feel free to open an issue.
+- [Image Generation Model Release — NovelAI Anime Diffusion V4 Curated Preview (EN)](https://blog.novelai.net/release-novelai-anime-diffusion-v4-curated-preview-en-ca4b0b11e671)
+- [Tutorial: Creating Consistent Characters with NovelAI Diffusion Anime [Female]](https://blog.novelai.net/tutorial-en-creating-consistent-characters-with-novelai-diffusion-anime-female-538b4b678a4e)
 
-### Usage 🖥️
+### 📦 Usage
 
 ```shell
 pip -U install novelai-python
 ```
 
-More examples can be found in the [playground](https://github.com/LlmKira/novelai-python/tree/main/playground)
-directory, read code as documentation.
+All API users must adhere to the NovelAI Terms of Service: https://novelai.net/terms.
+
+**More examples can be found in the [playground](https://github.com/LlmKira/novelai-python/tree/main/playground)
+directory, read code as documentation.**
 
 ```python
 import asyncio
@@ -58,6 +41,7 @@ from novelai_python.sdk.ai.generate_image.schema import PositionMap
 
 load_dotenv()
 session = ApiCredential(api_token=SecretStr(os.getenv("NOVELAI_JWT")))  # pst-***
+# For security reasons, storing user credentials in plaintext is strongly discouraged.
 
 prompt = "1girl, year 2023,dynamic angle,  best quality, amazing quality, very aesthetic, absurdres"
 
@@ -88,7 +72,7 @@ async def main():
     )
     cost = gen.calculate_cost(is_opus=True)
     print(f"charge: {cost} if you are vip3")
-    resp = gen.request(session=session)
+    resp = await gen.request(session=session)
     resp: ImageGenerateResp
     print(resp.meta)
     file = resp.files[0]
@@ -101,7 +85,7 @@ loop.run_until_complete(main())
 
 ```
 
-#### LLM
+#### 📦 LLM
 
 ```python
 import asyncio
@@ -152,29 +136,38 @@ loop = asyncio.get_event_loop()
 loop.run_until_complete(chat("Hello"))
 ```
 
-#### Random Prompt
+#### 📦 Random Prompt
 
 ```python
 from novelai_python.tool.random_prompt import RandomPromptGenerator
 
-prompt = RandomPromptGenerator(nsfw_enabled=False).random_prompt()
-print(prompt)
+generator = RandomPromptGenerator()
+for i in range(10):
+    print(generator.generate_common_tags(nsfw=False))
+    print(generator.generate_scene_tags())
+    print(generator.generate_scene_composition())
+    print(generator.get_holiday_themed_tags())
 ```
 
-#### Run A Server
+#### 📦 Run A Server
 
 ```shell
 pip install novelai_python
 python3 -m novelai_python.server -h '127.0.0.1' -p 7888
 ```
 
-#### Tokenizer
+#### 📦 Tokenizer
 
 ```python
-from novelai_python._enum import get_tokenizer_model, TextLLMModel
+from novelai_python._enum import get_tokenizer_model, TextLLMModel, TextTokenizerGroup
 from novelai_python.tokenizer import NaiTokenizer
 
+# Through llm model name to get the tokenizer
 tokenizer_package = NaiTokenizer(get_tokenizer_model(TextLLMModel.ERATO))
+# Directly use the tokenizer
+clip_tokenizer = NaiTokenizer(TextTokenizerGroup.CLIP)
+
+# Tokenize a text
 t_text = "a fox jumped over the lazy dog"
 encode_tokens = tokenizer_package.encode(t_text)
 print(tokenizer_package.tokenize_text(t_text))
@@ -183,7 +176,32 @@ print(tokenizer_package.decode(tokenizer_package.encode(t_text)))
 
 ```
 
-## About Nsfw 🚫
+### 🔨 Roadmap
+
+- [x] tool.random_prompt
+- [x] tool.paint_mask
+- [x] tool.image_metadata
+- [x] tokenizer
+- [x] /ai/generate-image
+- [x] /user/subscription
+- [x] /user/login
+- [x] /user/information
+- [x] /ai/upscale
+- [x] /ai/generate-image/suggest-tags
+- [x] /ai/generate-voice
+- [x] /ai/generate-stream
+- [x] /ai/generate
+- [x] /ai/augment-image
+- [ ] /ai/annotate-image
+- [ ] /ai/classify
+- [ ] /ai/generate-prompt
+
+> GenerateImageInfer.calculate_cost is correct in most cases, but please request account information to get accurate
+> consumption information.
+
+> This repo is maintained by me personally now. If you have any questions, please feel free to open an issue.
+
+## 🚫 About Nsfw
 
 You might need some solutions for identifying NSFW content and adding a mosaic to prevent operational mishaps.
 
@@ -191,9 +209,7 @@ https://dghs-imgutils.deepghs.org/main/api_doc/detect/nudenet.html
 
 https://dghs-imgutils.deepghs.org/main/api_doc/operate/censor.html
 
-## Acknowledgements 🙏
-
-[BackEnd](https://api.novelai.net/docs)
+## 🙏 Acknowledgements
 
 [novelai-api](https://github.com/Aedial/novelai-api)
 

{novelai_python-0.6.0 → novelai_python-0.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "novelai-python"
-version = "0.6.0"
+version = "0.7.0"
 description = "NovelAI Python Binding With Pydantic"
 authors = [
     { name = "sudoskys", email = "coldlando@hotmail.com" },
@@ -59,4 +59,5 @@ distribution = true
 [tool.pdm.dev-dependencies]
 dev = [
     "pre-commit>=3.5.0",
+    "wasmtime>=28.0.0",
 ]

{novelai_python-0.6.0 → novelai_python-0.7.0}/src/novelai_python/_enum.py

@@ -40,6 +40,7 @@ class TextTokenizerGroup(object):
     LLAMA3 = "llama3_tokenizer.def"
     GPT2 = "gpt2_tokenizer.def"
     CLIP = "clip_tokenizer.def"
+    T5 = "t5_tokenizer.def"
 
 
 TextLLMModelTypeAlias = Union[TextLLMModel, str]

{novelai_python-0.6.0 → novelai_python-0.7.0}/src/novelai_python/sdk/ai/generate/__init__.py

@@ -341,7 +341,8 @@ class LLM(ApiBaseModel):
                       override_headers: Optional[dict] = None
                       ) -> LLMResp:
         """
-        生成图片
+        Generate text using NovelAI's large language models. According to our Terms of Service, all generation requests must be initiated by a human action. Automating text or image generation to create excessive load on our systems is not allowed.
+
         :param override_headers:
         :param session:  session
         :return: LLMStreamResp

{novelai_python-0.6.0 → novelai_python-0.7.0}/src/novelai_python/sdk/ai/generate/_schema.py

@@ -115,7 +115,7 @@ class LLMGenerationParams(BaseModel):
     repetition_penalty_slope: Optional[Union[float, int]] = Field(default=None, ge=0, allow_inf_nan=False)
 
     eos_token_id: int = None
-    bad_words_ids: List[List[int]] = None
+    bad_words_ids: Optional[List[List[int]]] = None
     logit_bias_groups: Optional[List[LogitBiasGroup]] = Field(default_factory=list)
 
     repetition_penalty_frequency: Optional[Union[float, int]] = Field(default=None, allow_inf_nan=False)

{novelai_python-0.6.0 → novelai_python-0.7.0}/src/novelai_python/sdk/ai/generate_image/__init__.py

@@ -7,7 +7,6 @@ import json
 import math
 import random
 from copy import deepcopy
-from dataclasses import field
 from io import BytesIO
 from typing import Optional, Union, Tuple, List
 from urllib.parse import urlparse
@@ -28,7 +27,7 @@ from novelai_python.sdk.ai._cost import CostCalculator
 from novelai_python.sdk.ai._enum import Model, Sampler, NoiseSchedule, ControlNetModel, Action, UCPreset, \
     INPAINTING_MODEL_LIST, get_default_uc_preset, \
     ModelTypeAlias, UCPresetTypeAlias, get_default_noise_schedule, get_supported_noise_schedule, \
-    get_model_group, ModelGroups, get_supported_params, get_modifiers
+    get_model_group, ModelGroups, get_supported_params, get_modifiers, ImageBytesTypeAlias
 from .schema import Character, V4Prompt, V4NegativePrompt
 from ...schema import ApiBaseModel
 from ...._exceptions import APIError, AuthError, ConcurrentGenerationError, SessionHttpError
@@ -79,7 +78,7 @@ class Params(BaseModel):
     """Noise Schedule"""
     legacy_v3_extend: Optional[bool] = False
     """Legacy V3 Extend"""
-    mask: Union[bytes, str] = None
+    mask: ImageBytesTypeAlias = None
     """Mask for Inpainting"""
     seed: int = Field(
         default_factory=lambda: random.randint(0, 4294967295 - 7),
@@ -87,13 +86,13 @@ class Params(BaseModel):
         le=4294967295 - 7,
     )
     """Seed"""
-    image: Union[bytes, str] = None
+    image: ImageBytesTypeAlias = None
     """Image for img2img"""
     negative_prompt: Optional[str] = ''
     """Negative Prompt"""
-    reference_image_multiple: Optional[List[Union[str, bytes]]] = field(default_factory=list)
+    reference_image_multiple: Optional[List[Union[str, bytes]]] = Field(default_factory=list)
     """Reference Image For Vibe Mode"""
-    reference_information_extracted_multiple: Optional[List[float]] = field(default_factory=list)
+    reference_information_extracted_multiple: Optional[List[float]] = Field(default_factory=list)
     """Reference Information Extracted For Vibe Mode"""
     reference_strength_multiple: Optional[List[float]] = Field(
         default=list,
@@ -113,7 +112,7 @@ class Params(BaseModel):
     """
     use_coords: bool = Field(True, description="Use Coordinates")
     """Use Coordinates"""
-    characterPrompts: List[Character] = field(default_factory=list)
+    characterPrompts: List[Character] = Field(default_factory=list)
     """Character Prompts"""
 
     v4_prompt: Optional[V4Prompt] = Field(None, description="V4 Prompt")
@@ -136,6 +135,12 @@ class Params(BaseModel):
     uncond_scale: Optional[float] = Field(None, ge=0, le=1.5, multiple_of=0.05)
     """Undesired Content Strength"""
 
+    @model_validator(mode="after")
+    def v_character(self):
+        if len(self.characterPrompts) > 6:
+            raise ValueError("Too many character given")
+        return self
+
     @field_validator('uncond_scale')
     def v_uncond_scale(cls, v: float):
         """
@@ -684,10 +689,9 @@ class GenerateImageInfer(ApiBaseModel):
 
         If you need to define more parameters, you should initialize the Param class yourself.
 
-        :param controlnet_strength:
         :param strength:
         :param image:
-        :param noise: For img2img
+        :param noise: For image to image
         :param extra_noise_seed: Get extra_noise_seed
         :param reference_information_extracted_multiple:
         :param reference_strength_multiple:
@@ -887,7 +891,8 @@ class GenerateImageInfer(ApiBaseModel):
                       override_headers: Optional[dict] = None,
                       ) -> ImageGenerateResp:
         """
-        生成图片
+        Generate images using NovelAI's diffusion models. According to our Terms of Service, all generation requests must be initiated by a human action. Automating text or image generation to create excessive load on our systems is not allowed.
+
         :param override_headers: the headers to override
         :param session:  session
         :return:

{novelai_python-0.6.0 → novelai_python-0.7.0}/src/novelai_python/tokenizer/__init__.py

@@ -1,5 +1,6 @@
 import gzip
 import io
+import json
 import pathlib
 import zlib
 from typing import Dict, List, Optional
@@ -56,6 +57,14 @@ class LLMTokenizerSetting(TokenizerSetting):
         return self
 
 
+def is_clip_model(model_name: str) -> bool:
+    return model_name.lower().startswith("clip_tokenizer")
+
+
+def is_t5_model(model_name: str) -> bool:
+    return model_name.lower().startswith("t5_tokenizer")
+
+
 class NaiTokenizer:
     def __init__(self,
                  model: str,
@@ -129,8 +138,10 @@ class NaiTokenizer:
         decoded_str = self._read_compressed_def(model_bytes)
         repaired_data = repair_json(decoded_str, return_objects=True)
         try:
-            if "clip" in self.model_full_name.lower():
+            if is_clip_model(self.model_full_name):
                 self.tokenizer_setting = ClipTokenizerSetting.model_validate(repaired_data)
+            elif is_t5_model(self.model_full_name):
+                self.tokenizer_setting = json.dumps(repaired_data)
             else:
                 self.tokenizer_setting = LLMTokenizerSetting.model_validate(repaired_data)
         except Exception as e:
@@ -140,8 +151,10 @@ class NaiTokenizer:
             )
 
     def _create_tokenizer(self):
-        if "clip" in self.model_full_name.lower():
+        if is_clip_model(self.model_full_name):
             self._create_clip_tokenizer()
+        elif is_t5_model(self.model_full_name):
+            self.tokenizer = Tokenizer.from_str(self.tokenizer_setting)
         else:
             self._create_bpe_tokenizer()