Fix ruff warnings

Author: YoanSallami

README.md

@@ -7,7 +7,7 @@
 
 
 <p align="center">
-  <a href="https://github.com/SynaLinks/synalinks" target="_blank"><strong>Documentation</strong></a> ·
+  <a href="https://synalinks.github.io/synalinks" target="_blank"><strong>Documentation</strong></a> ·
   <a href="https://discord.gg/82nt97uXcM" target="_blank"><strong>Discord</strong></a> ·
   <a href="https://huggingface.co/spaces/YoanSallami/synalinks-noteboooks" target="_blank"><strong>Code Examples</strong></a>
 </p>

synalinks/api/backend/__init__.py

@@ -6,6 +6,7 @@
 
 from synalinks.src.backend import DataModel
 from synalinks.src.backend.common.global_state import clear_session
+from synalinks.src.backend.common.json_data_model import is_json_data_model
 from synalinks.src.backend.common.symbolic_data_model import is_symbolic_data_model
 from synalinks.src.backend.config import api_key
 from synalinks.src.backend.config import backend

synalinks/api/utils/__init__.py

@@ -5,6 +5,7 @@
 """
 
 from synalinks.src.backend.common.global_state import clear_session
+from synalinks.src.backend.common.json_data_model import is_json_data_model
 from synalinks.src.backend.common.symbolic_data_model import is_symbolic_data_model
 from synalinks.src.backend.pydantic.core import is_meta_class
 from synalinks.src.saving.object_registration import CustomObjectScope

synalinks/src/backend/common/json_data_model.py

@@ -60,15 +60,15 @@ class Query(synalinks.DataModel):
         data_model=query_instance,
     )
     ```
-    
+
     **Creating a `JsonDataModel` with `to_json_data_model()`:**
-    
+
     ```python
     class Query(synalinks.DataModel):
         query: str = synalinks.Field(
             description="The user query",
         )
-        
+
     data_model = Query(
         query="What is the capital of France?",
     ).to_json_data_model()
@@ -184,7 +184,7 @@ def __radd__(self, other):
         """Concatenates another data model with this one.
 
         Args:
-            other (JsonDataModel | DataModel): 
+            other (JsonDataModel | DataModel):
                 The other data model to concatenate with.
 
         Returns:
@@ -195,7 +195,7 @@ def __radd__(self, other):
         return asyncio.get_event_loop().run_until_complete(
             ops.Concat().call(other, self),
         )
-        
+
     def __and__(self, other):
         """Perform a `logical_and` with another data model.
 
@@ -214,7 +214,7 @@ def __and__(self, other):
         return asyncio.get_event_loop().run_until_complete(
             ops.And().call(self, other),
         )
-        
+
     def __rand__(self, other):
         """Perform a `logical_and` (reverse) with another data model.
 
@@ -233,7 +233,7 @@ def __rand__(self, other):
         return asyncio.get_event_loop().run_until_complete(
             ops.And().call(other, self),
         )
-        
+
     def __or__(self, other):
         """Perform a `logical_or` with another data model
 
@@ -245,14 +245,15 @@ def __or__(self, other):
 
         Returns:
             (JsonDataModel | None): The concatenation of data model if both are provided,
-                or the non-None data model or None if none are provided. (See `logical_or` table).
+                or the non-None data model or None if none are provided.
+                (See `logical_or` table).
         """
         from synalinks.src import ops
 
         return asyncio.get_event_loop().run_until_complete(
             ops.Or().call(self, other),
         )
-        
+
     def __ror__(self, other):
         """Perform a `logical_or` (reverse) with another data model
 
@@ -264,7 +265,8 @@ def __ror__(self, other):
 
         Returns:
             (JsonDataModel | None): The concatenation of data model if both are provided,
-                or the non-None data model or None if none are provided. (See `logical_or` table).
+                or the non-None data model or None if none are provided.
+                (See `logical_or` table).
         """
         from synalinks.src import ops
 
@@ -376,7 +378,7 @@ def __repr__(self):
 )
 def is_json_data_model(x):
     """Returns whether `x` is a backend-independent data model.
-    
+
     Args:
         x (any): The object to check.
 

synalinks/src/backend/common/symbolic_data_model.py

@@ -56,11 +56,11 @@ class Query(synalinks.DataModel):
 
     data_model = SymbolicDataModel(schema=Query.schema())
     ```
-    
+
     **Creating a `SymbolicDataModel` with `to_symbolic_data_model()`:**
-    
+
     using a backend data model metaclass
-    
+
     ```python
     class Query(synalinks.DataModel):
         query: str = synalinks.Field(
@@ -127,22 +127,22 @@ def schema(self):
             (dict): The JSON schema.
         """
         return self._schema
-    
+
     def json(self, key):
         """Alias for the JSON object's value (impossible in `SymbolicDataModel`).
-        
+
         Implemented to help the user to identifying issues.
-        
+
         Raises:
             ValueError: The help message.
         """
         return self.value()
-        
+
     def value(self):
         """The current value of the JSON object (impossible in `SymbolicDataModel`).
-        
+
         Implemented to help the user to identifying issues.
-        
+
         Raises:
             ValueError: The help message.
         """
@@ -203,7 +203,8 @@ def __and__(self, other):
         then concatenates this data model with the other.
 
         Args:
-            other (SymbolicDataModel | DataModel): The other data model to concatenate with.
+            other (SymbolicDataModel | DataModel): The other data model to concatenate
+                with.
 
         Returns:
             (SymbolicDataModel | None): The concatenated data model or None
@@ -222,7 +223,8 @@ def __rand__(self, other):
         then concatenates the other data model with this one.
 
         Args:
-            other (SymbolicDataModel | DataModel): The other data model to concatenate with.
+            other (SymbolicDataModel | DataModel): The other data model to concatenate
+                with.
 
         Returns:
             (SymbolicDataModel | None): The concatenated data model or None
@@ -244,8 +246,9 @@ def __or__(self, other):
             other (SymbolicDataModel): The other data model to concatenate with.
 
         Returns:
-            (SymbolicDataModel | None): The concatenation of data model if both are provided,
-                or the non-None data model or None if none are provided. (See `logical_or` table).
+            (SymbolicDataModel | None): The concatenation of data model if both are
+                provided, or the non-None data model or None if none are provided.
+                (See `logical_or` table).
         """
         from synalinks.src import ops
 
@@ -260,11 +263,13 @@ def __ror__(self, other):
         then concatenates the other data model with this one.
 
         Args:
-            other (SymbolicDataModel | DataModel): The other data model to concatenate with.
+            other (SymbolicDataModel | DataModel): The other data model to concatenate
+                with.
 
         Returns:
-            (SymbolicDataModel | None): The concatenation of data model if both are provided,
-                or the non-None data model or None if none are provided. (See `logical_or` table).
+            (SymbolicDataModel | None): The concatenation of data model if both are
+                provided, or the non-None data model or None if none are provided.
+                (See `logical_or` table).
         """
         from synalinks.src import ops
 
@@ -290,7 +295,7 @@ def in_mask(self, mask=None, recursive=True):
         Args:
             mask (list): The mask to be applied (list of keys).
             recursive (bool): Optional. Whether to apply the mask recursively.
-                Defaults to True.
+                Defaults to `True`.
 
         Returns:
             (SymbolicDataModel): The data model with the mask applied.
@@ -307,7 +312,7 @@ def out_mask(self, mask=None, recursive=True):
         Args:
             mask (list): The mask to be applied (list of keys).
             recursive (bool): Optional. Whether to apply the mask recursively.
-                Defaults to True.
+                Defaults to `True`.
 
         Returns:
             (SymbolicDataModel): The data model with the mask applied.
@@ -350,12 +355,12 @@ def suffix(self, suffix=None):
 
     def get(self, key):
         """Get wrapper to make easier to access fields.
-        
+
         Implemented to help the user to identifying issues.
 
         Args:
             key (str): The key to access.
-            
+
         Raises:
             ValueError: The help message.
         """
@@ -368,12 +373,12 @@ def get(self, key):
 
     def update(self, kv_dict):
         """Update wrapper to make easier to modify fields.
-        
+
         Implemented to help the user to identifying issues.
 
         Args:
             kv_dict (dict): The key/value dict to update.
-            
+
         Raises:
             ValueError: The help message.
         """

synalinks/src/backend/common/variables.py

@@ -24,7 +24,7 @@ class Variable:
 
     A Variable is different from a JsonDataModel as it can be modified by the optimizers
 
-    Note that the DataModel used for the variable declaration 
+    Note that the DataModel used for the variable declaration
     **must have a default value** for each of its field.
 
     Examples:

synalinks/src/backend/config.py

@@ -58,7 +58,8 @@ def set_floatx(value):
     Instead, use `float64` or `float32`.
 
     Args:
-        value (str): The float type `'bfloat16'`, `'float16'`, `'float32'`, or `'float64'`.
+        value (str): The float type between `'bfloat16'`, `'float16'`, `'float32'`,
+            or `'float64'`.
 
     Examples: