artificialbrains-sdk 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

ab_sdk/client.py

@@ -13,7 +13,7 @@ Usage example::
 
     from ab_sdk import ABClient
 
-    client = ABClient("https://brains.example.com/api", api_key="your_key")
+    client = ABClient("https://app.artificialbrains.ai/api", api_key="your_key")
     run = client.start("my_project")
     # ... attach sensors, run loop ...
     client.stop("my_project")
@@ -52,8 +52,7 @@ class ABClient:
 
     Base URL:
       - Provide either:
-          * https://artificialbrains.app/api
-          * http://localhost:3000/api
+          * https://app.artificialbrains.ai/api
         If you pass a host without `/api`, the client will append `/api` automatically.
     """
 

{artificialbrains_sdk-0.1.0.dist-info → artificialbrains_sdk-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: artificialbrains_sdk
-Version: 0.1.0
+Version: 0.1.2
 Summary: ArtificialBrains Python SDK
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: Other/Proprietary License
@@ -34,11 +34,9 @@ protocol.
   sensor data
 - **Generic spike decoders** that convert brain output spikes into
   actuator deltas using flexible mapping rules and decoding schemes
-  commands; includes a ready to use bipolar split decoder
-- **Deviation and reward plugins** for computing error signals and
-  global/per‑layer rewards
+  commands; includes four ready to use decoders
 - **Feedback error generator** to build correction spikes from
-  deviations
+  deviations (for sensory-motor feedback)
 - **Reward modulation** helper mirroring biological-brains behaviour around rewards for learning rules
 
 The SDK abstracts away the networking details and allows you to
@@ -49,7 +47,7 @@ focus on your controller and learning logic.
 ### Install from PyPI (recommended)
 
 ```bash
-pip install artificialbrains_sdk
+pip install artificialbrains-sdk
 ```
 
 This installs the official, versioned ArtificialBrains Python SDK.
@@ -69,7 +67,7 @@ pip install git+https://github.com/artificial-brains-inc/artificial_brains_sdk_p
 
 ### Requirements
 
-This SDK requires Python **3.8** or newer.  It depends on the
+This SDK requires Python **3.12** or newer.  It depends on the
 following third party libraries:
 
 - [`python‑socketio` ≥ 5.16.0](https://pypi.org/project/python-socketio/), released on
@@ -102,12 +100,25 @@ The typical workflow when using this SDK is:
 
    ```python
    from ab_sdk import ABClient
-   client = ABClient("https://artificialbrains.app/api/", api_key="my_secret")
+   client = ABClient("https://app.artificialbrains.ai/api/", api_key="my_secret")
+   client.sync_policies(PROJECT_ID, policies_dir="policies")
    
    # start a run for project 'project_id' -- you'll find it in your project. 
    run = client.start("rproject_id")
    ```
 
+An .env file for the SDK would need the following information: 
+  ``` python
+  # Copy this file to `.env` and fill in your own values
+  # API key for the Artificial Brains service
+    API_KEY=YOUR_API_KEY
+  # Project identifier to start a run (the backend expects a numeric or string ID) Genesis: 691cb6bc14e402b5ee225c21
+  PROJECT_ID=YOUR_PROJECT_ID
+  # Your namespace and URL (leave them as they are unless you have an assigned environments)
+  SOCKET_NAMESPACE=/ab
+  AB_BASE_URL=https://app.artificialbrains.ai/api
+  ```
+
 2. Attach sensor providers and start streaming inputs:
 
    ```python
@@ -221,10 +232,10 @@ The decoder produces **per-timestep actuator deltas**, leaving all
 integration, physics, and control semantics to the user’s controller.
  
  
-4. (Optional) Sync the project contract and scaffold learning policies:
+4. (Optional but recommended) Sync the project contract and scaffold learning policies, before initialization:
 
    ```python
-   client.sync_policies("robot_arm", policies_dir="policies")
+   client.sync_policies(PROJECT_ID, policies_dir="policies")
    ```
 
    This creates reward and deviation policy files that can be customized

{artificialbrains_sdk-0.1.0.dist-info → artificialbrains_sdk-0.1.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ab_sdk/__init__.py,sha256=tYSMwbFzqsiZ7Bp7mYy2kQ0rX9I1NwM6wS1hEGYuze4,1831
-ab_sdk/client.py,sha256=DDpJSAZOuoQ9wc_7cnM6-_u0Q5B3YdriDfgUD3w8AHk,10174
+ab_sdk/client.py,sha256=TvANQpuEgjDYn51tIcXtGijHrqFUVXKPGXjKMRbWflc,10144
 ab_sdk/contract_scaffold.py,sha256=4zcsWhd9axxMu--FZ7U8B8u4QLUwluifyvqac2apDno,8930
 ab_sdk/endpoints.py,sha256=yc4h_E8vQA9TmWF0sW2GprgE0QnS3eBetH13ogeuw4E,2102
 ab_sdk/input_streamer.py,sha256=fRPlBimaTDBsm1gz9cdoYanVbmwYTBXSyI9IrXslXiM,6847
@@ -9,7 +9,7 @@ ab_sdk/plugins/__init__.py,sha256=veHfKqvymY8YPN9HF4E1S4pwRUcVVJHDAyBZptbLNlA,18
 ab_sdk/plugins/decoder.py,sha256=vHAubiAPOaOg3J006TLjn4qAoLIu2Lz2D2kjz421odc,10148
 ab_sdk/plugins/deviation.py,sha256=QLKOqOSa9HIj3Z3bO6oR79wY1Lni_P-j3GAGM7UYKVs,2019
 ab_sdk/plugins/reward.py,sha256=E5IsV29N6juyfIQ7ZksDa8JSxAAbVflaJOtLplilAD4,1796
-artificialbrains_sdk-0.1.0.dist-info/METADATA,sha256=WjkBvIZfbl1NmfHrBHfr_RFQLUbqrCRQDgAj76RLoqU,11788
-artificialbrains_sdk-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-artificialbrains_sdk-0.1.0.dist-info/top_level.txt,sha256=Ttsz2oF0qRh68OI9w3mu_LKkv2I_YvOWr3kudSpckpM,7
-artificialbrains_sdk-0.1.0.dist-info/RECORD,,
+artificialbrains_sdk-0.1.2.dist-info/METADATA,sha256=kBo5QySU83Hxgv6JeJriRWQAb0aoF75OOhM3FHMOo0o,12338
+artificialbrains_sdk-0.1.2.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+artificialbrains_sdk-0.1.2.dist-info/top_level.txt,sha256=Ttsz2oF0qRh68OI9w3mu_LKkv2I_YvOWr3kudSpckpM,7
+artificialbrains_sdk-0.1.2.dist-info/RECORD,,

{artificialbrains_sdk-0.1.0.dist-info → artificialbrains_sdk-0.1.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.1)
 Root-Is-Purelib: true
 Tag: py3-none-any