Markdown clean up

griptape-ai · Oct 25, 2024 · 18ff8d5 · 18ff8d5
1 parent 338e825
commit 18ff8d5
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,31 +33,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **BREAKING**: Moved `griptape.common.observable.observable` to `griptape.common.decorators.observable`.
 - **BREAKING**: `AnthropicDriversConfig` no longer bundles `VoyageAiEmbeddingDriver`.
 - **BREAKING**: Removed redundant Engines, use their respective Drivers instead.
- - Removed `ImageQueryEngine`, use `ImageQueryDriver`s instead.
- - Removed `InpaintingImageGenerationEngine`, use `ImageGenerationDriver`s instead.
- - Removed `OutpaintingImageGenerationEngine`, use `ImageGenerationDriver`s instead.
- - Removed `VariationImageGenerationEngine`, use `ImageGenerationDriver`s instead.
- - Removed `PromptImageGenerationEngine`, use `ImageGenerationDriver`s instead.
- - Removed `ImageGenerationEngine`, use `ImageGenerationDriver`s instead.
- - Removed `AudioTranscriptionEngine`, use `AudioTranscriptionDriver`s instead.
- - Removed `TextToSpeechEngine`, use `TextToSpeechDriver`s instead.
+  - Removed `ImageQueryEngine`, use `ImageQueryDriver`s instead.
+  - Removed `InpaintingImageGenerationEngine`, use `ImageGenerationDriver`s instead.
+  - Removed `OutpaintingImageGenerationEngine`, use `ImageGenerationDriver`s instead.
+  - Removed `VariationImageGenerationEngine`, use `ImageGenerationDriver`s instead.
+  - Removed `PromptImageGenerationEngine`, use `ImageGenerationDriver`s instead.
+  - Removed `ImageGenerationEngine`, use `ImageGenerationDriver`s instead.
+  - Removed `AudioTranscriptionEngine`, use `AudioTranscriptionDriver`s instead.
+  - Removed `TextToSpeechEngine`, use `TextToSpeechDriver`s instead.
 - **BREAKING**: Tools that previously took Engines now take their respective Drivers.
- - Updated `AudioTranscriptionTool.engine` to `AudioTranscriptionTool.audio_transcription_driver`.
- - Updated `TextToSpeechTool.engine` to `TextToSpeechTool.text_to_speech_driver`.
- - Updated `ImageQueryTool.image_query_engine` to `ImageQueryTool.image_query_driver`.
- - Updated `InpaintingImageGenerationTool.engine` to `InpaintingImageGenerationTool.image_generation_driver`.
- - Updated `OutpaintingImageGenerationTool.engine` to `OutpaintingImageGenerationTool.image_generation_driver`.
- - Updated `VariationImageGenerationTool.engine` to `VariationImageGenerationTool.image_generation_driver`.
- - Updated `PromptImageGenerationTool.engine` to `PromptImageGenerationTool.image_generation_driver`.
+  - Updated `AudioTranscriptionTool.engine` to `AudioTranscriptionTool.audio_transcription_driver`.
+  - Updated `TextToSpeechTool.engine` to `TextToSpeechTool.text_to_speech_driver`.
+  - Updated `ImageQueryTool.image_query_engine` to `ImageQueryTool.image_query_driver`.
+  - Updated `InpaintingImageGenerationTool.engine` to `InpaintingImageGenerationTool.image_generation_driver`.
+  - Updated `OutpaintingImageGenerationTool.engine` to `OutpaintingImageGenerationTool.image_generation_driver`.
+  - Updated `VariationImageGenerationTool.engine` to `VariationImageGenerationTool.image_generation_driver`.
+  - Updated `PromptImageGenerationTool.engine` to `PromptImageGenerationTool.image_generation_driver`.
 - **BREAKING**: Tasks that previously took Engines now take their respective Drivers.
- - Updated `AudioTranscriptionTask.audio_transcription_engine` to `AudioTranscriptionTask.audio_transcription_driver`.
- - Updated `TextToSpeechTask.text_to_speech_engine` to `TextToSpeechTask.text_to_speech_driver`.
- - Updated `ImageQueryTask.image_query_engine` to `ImageQueryTask.image_query_driver`.
- - Updated `InpaintingImageGenerationTask.image_query_engine` to `InpaintingImageGenerationTask.image_generation_driver`.
- - Updated `OutpaintingImageGenerationTask.image_query_engine` to `OutpaintingImageGenerationTask.image_generation_driver`.
- - Updated `VariationImageGenerationTask.image_query_engine` to `VariationImageGenerationTask.image_generation_driver`.
- - Updated `PromptImageGenerationTask.image_query_engine` to `PromptImageGenerationTask.image_generation_driver`.
-- **BREAKING**: Renamed`RuleMixin.all_rulesets` to `RuleMixin.rulesets`.
+  - Updated `AudioTranscriptionTask.audio_transcription_engine` to `AudioTranscriptionTask.audio_transcription_driver`.
+  - Updated `TextToSpeechTask.text_to_speech_engine` to `TextToSpeechTask.text_to_speech_driver`.
+  - Updated `ImageQueryTask.image_query_engine` to `ImageQueryTask.image_query_driver`.
+  - Updated `InpaintingImageGenerationTask.image_query_engine` to `InpaintingImageGenerationTask.image_generation_driver`.
+  - Updated `OutpaintingImageGenerationTask.image_query_engine` to `OutpaintingImageGenerationTask.image_generation_driver`.
+  - Updated `VariationImageGenerationTask.image_query_engine` to `VariationImageGenerationTask.image_generation_driver`.
+  - Updated `PromptImageGenerationTask.image_query_engine` to `PromptImageGenerationTask.image_generation_driver`.
+- **BREAKING**: Renamed`BaseImageGenerationTask.all_negative_rulesets` to `BaseImageGenerationTask.negative_rulesets`.
 - `BaseImageGenerationTask` no longer prevents setting `negative_rulesets` _and_ `negative_rules` at the same time.
 - Updated `EventListener.handler` return type to `Optional[BaseEvent | dict]`.
 - `BaseTask.parent_outputs` type has changed from `dict[str, str | None]` to `dict[str, BaseArtifact]`.

diff --git a/MIGRATION.md b/MIGRATION.md
@@ -40,6 +40,7 @@ Defaults.drivers_config = AnthropicDriversConfig(
 `ImageQueryEngine` has been removed. Use `ImageQueryDriver` instead.
 
 #### Before
+
 ```python
 from griptape.drivers import OpenAiImageQueryDriver
 from griptape.engines import ImageQueryEngine
@@ -55,6 +56,7 @@ engine.run("Describe the weather in the image", [image_artifact])`
 ```
 
 #### After
+
 ```python
 from griptape.drivers import OpenAiImageQueryDriver
 from griptape.engines import ImageQueryEngine
@@ -72,7 +74,8 @@ driver.query("Describe the weather in the image", [image_artifact])`
 `InpaintingImageGenerationEngine` has been removed. Use `InpaintingImageGenerationDriver` instead.
 
 #### Before
-```python
+
+````python
 from griptape.drivers import OpenAiImageGenerationDriver
 from griptape.engines import InpaintingImageGenerationEngine
 from griptape.loaders import ImageLoader
@@ -92,8 +95,6 @@ engine.run(
     mask=mask_artifact,
 )```
 
-
-
 #### After
 ```python
 from griptape.drivers import OpenAiImageGenerationDriver
@@ -110,13 +111,14 @@ driver.run_image_inpainting(
     image=image_artifact,
     mask=mask_artifact,
 )
-```
+````
 
 ### Removed `OutpaintingImageGenerationEngine`
 
 `OutpaintingImageGenerationEngine` has been removed. Use `OutpaintingImageGenerationDriver` instead.
 
 #### Before
+
 ```python
 from griptape.drivers import OpenAiImageGenerationDriver
 from griptape.engines import OutpaintingImageGenerationEngine
@@ -135,6 +137,7 @@ engine.run(
 ```
 
 #### After
+
 ```python
 from griptape.drivers import OpenAiImageGenerationDriver
 from griptape.loaders import ImageLoader
@@ -154,6 +157,7 @@ driver.run_image_outpainting(
 `VariationImageGenerationEngine` has been removed. Use `VariationImageGenerationDriver` instead.
 
 #### Before
+
 ```python
 from griptape.drivers import OpenAiImageGenerationDriver
 from griptape.engines import VariationImageGenerationEngine
@@ -172,6 +176,7 @@ engine.run(
 ```
 
 #### After
+
 ```python
 from griptape.drivers import OpenAiImageGenerationDriver
 from griptape.loaders import ImageLoader
@@ -191,6 +196,7 @@ driver.run_image_variation(
 `PromptImageGenerationEngine` has been removed. Use `PromptImageGenerationDriver` instead.
 
 #### Before
+
 ```python
 from griptape.drivers import OpenAiImageGenerationDriver
 from griptape.engines import PromptImageGenerationEngine
@@ -205,6 +211,7 @@ engine.run(
 ```
 
 #### After
+
 ```python
 from griptape.drivers import OpenAiImageGenerationDriver