simudyne-pulse 0.7.0.dev4__tar.gz → 0.7.0.dev5__tar.gz

{simudyne_pulse-0.7.0.dev4 → simudyne_pulse-0.7.0.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev4
+Version: 0.7.0.dev5
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT

{simudyne_pulse-0.7.0.dev4 → simudyne_pulse-0.7.0.dev5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simudyne-pulse"
-version = "0.7.0-dev.4"
+version = "0.7.0-dev.5"
 description = "Python SDK for the Simudyne Pulse synthetic market data API"
 readme = "README.md"
 license = "MIT"

{simudyne_pulse-0.7.0.dev4 → simudyne_pulse-0.7.0.dev5}/src/simudyne/resources/data.py

@@ -20,19 +20,28 @@ class DataResource:
         All arguments are optional filters; with none passed the whole catalog
         comes back, as before.
 
-        Args:
-            symbol: Exact symbol, e.g. "700.HK".
-            exchange: Exchange protocol, e.g. "hkex_securities".
-            provider: Data provider, e.g. "omd" or "bmll".
-            date: Calibration date "YYYY-MM-DD". Keeps only instruments
-                  calibrated on that date, and narrows each instrument's
-                  available_dates to it.
-            q: Case-insensitive substring match over ticker and company name.
-            limit: Max instruments to return.
-            offset: Instruments to skip (for paging alongside limit).
+        Parameters
+        ----------
+        symbol : str, optional
+            Exact symbol, e.g. "700.HK".
+        exchange : str, optional
+            Exchange protocol, e.g. "hkex_securities".
+        provider : str, optional
+            Data provider, e.g. "omd" or "bmll".
+        date : str, optional
+            Calibration date "YYYY-MM-DD". Keeps only instruments
+            calibrated on that date, and narrows each instrument's
+            available_dates to it.
+        q : str, optional
+            Case-insensitive substring match over ticker and company name.
+        limit : int, optional
+            Max instruments to return.
+        offset : int, optional
+            Instruments to skip (for paging alongside limit).
 
-        Returns:
-            list of instrument dicts, each with available_dates.
+        Returns
+        -------
+        list of instrument dicts, each with available_dates.
         """
         params = {
             k: v for k, v in {

{simudyne_pulse-0.7.0.dev4 → simudyne_pulse-0.7.0.dev5}/src/simudyne/resources/fix.py

@@ -18,13 +18,15 @@ class FixResource:
     def usage(self) -> dict:
         """FIX simulation statistics: what was run over FIX, and how often.
 
-        Returns:
-            dict with ``total_runs``, ``simulated_seconds``, and ``runs`` — one
+        Returns
+        -------
+        dict with ``total_runs``, ``simulated_seconds``, and ``runs`` — one
             entry per distinct configuration, each with its ``symbol``,
             ``cal_date``, ``scenario`` and ``runs`` count.
 
-        Example:
-            >>> usage = client.fix.usage()
-            >>> print(f"{usage['total_runs']} FIX runs")
+        Examples
+        --------
+        >>> usage = client.fix.usage()
+        >>> print(f"{usage['total_runs']} FIX runs")
         """
         return self._client._request("GET", USAGE_PATH)

{simudyne_pulse-0.7.0.dev4 → simudyne_pulse-0.7.0.dev5}/src/simudyne/resources/fm.py

@@ -47,8 +47,9 @@ class FmResource:
         ``min_prompt_rows``, and the ``model_args`` descriptors for the knobs
         run() will accept. Pro tier.
 
-        Returns:
-            dict with a ``models`` list.
+        Returns
+        -------
+        dict with a ``models`` list.
         """
         return self._client._request("GET", MODELS_PATH)
 
@@ -71,19 +72,29 @@ class FmResource:
         restricts the result to the (provider, exchange) markets that model's
         ``supported_data`` declares — exactly what run() will accept.
 
-        Args:
-            model_id: Registered model (see models()). Unknown id -> 404.
-            symbol: Exact symbol, e.g. "TSCO" or "700".
-            q: Case-insensitive substring match over the symbol.
-            provider: Data provider, e.g. "bmll".
-            exchange: Protocol, e.g. "lse" or "hkex_securities".
-            date: Trading date YYYY-MM-DD; keeps only symbols with data on it,
-                and only that date.
-            limit: Max symbols to return (default 50, max 200).
-            offset: Symbols to skip, for paging.
-
-        Returns:
-            dict with ``symbols`` (each with its provider, exchange and dates)
+        Parameters
+        ----------
+        model_id : str, optional
+            Registered model (see models()). Unknown id -> 404.
+        symbol : str, optional
+            Exact symbol, e.g. "TSCO" or "700".
+        q : str, optional
+            Case-insensitive substring match over the symbol.
+        provider : str, optional
+            Data provider, e.g. "bmll".
+        exchange : str, optional
+            Protocol, e.g. "lse" or "hkex_securities".
+        date : str, optional
+            Trading date YYYY-MM-DD; keeps only symbols with data on it,
+            and only that date.
+        limit : int, default 50
+            Max symbols to return (default 50, max 200).
+        offset : int, default 0
+            Symbols to skip, for paging.
+
+        Returns
+        -------
+        dict with ``symbols`` (each with its provider, exchange and dates)
             and ``total``, paged by symbol identity.
         """
         params = {"limit": limit, "offset": offset}
@@ -112,28 +123,42 @@ class FmResource:
     ) -> dict:
         """Submit a foundation-model inference job. Pro tier.
 
-        Args:
-            model_id: A model from models().
-            symbol: Symbol whose real data becomes the prompt context.
-            cal_date: Trading date of the prompt, YYYY-MM-DD.
-            provider: Data provider, e.g. "bmll".
-            exchange: Exchange protocol, e.g. "hkex_securities".
-            duration_minutes: Sim horizon as wall-clock minutes measured from
-                the first row of the context. The resulting frame count is
-                reported in the run's output rather than requested up front.
-            horizon: Raw frame count — the older form; applies only when
-                duration_minutes is unset.
-            n_runs: Monte Carlo runs, 1-8 (per-run seeds derived from ``seed``
-                exactly as the ABM derives them).
-            seed: Random seed (default 42).
-            model_args: Overrides for the model's declared knobs (see
-                models()); unknown or out-of-range keys are rejected with 400.
-            device: "cpu" or "gpu"; None uses the model's default.
-            exec_algos: Execution algorithms, the ABM's config shape. At most
-                one per job; market runs only.
-
-        Returns:
-            dict with job_id, the model version, and the queued sim_ids.
+        Parameters
+        ----------
+        model_id : str
+            A model from models().
+        symbol : str
+            Symbol whose real data becomes the prompt context.
+        cal_date : str
+            Trading date of the prompt, YYYY-MM-DD.
+        provider : str
+            Data provider, e.g. "bmll".
+        exchange : str
+            Exchange protocol, e.g. "hkex_securities".
+        duration_minutes : float, optional
+            Sim horizon as wall-clock minutes measured from
+            the first row of the context. The resulting frame count is
+            reported in the run's output rather than requested up front.
+        horizon : int, optional
+            Raw frame count — the older form; applies only when
+            duration_minutes is unset.
+        n_runs : int, default 1
+            Monte Carlo runs, 1-8 (per-run seeds derived from ``seed``
+            exactly as the ABM derives them).
+        seed : int, default 42
+            Random seed (default 42).
+        model_args : dict, optional
+            Overrides for the model's declared knobs (see
+            models()); unknown or out-of-range keys are rejected with 400.
+        device : str, optional
+            "cpu" or "gpu"; None uses the model's default.
+        exec_algos : list, optional
+            Execution algorithms, the ABM's config shape. At most
+            one per job; market runs only.
+
+        Returns
+        -------
+        dict with job_id, the model version, and the queued sim_ids.
         """
         payload = {
             "model_id": model_id,
@@ -165,8 +190,9 @@ class FmResource:
     ) -> dict:
         """Start a live streaming session instead of a batch job. Pro tier.
 
-        Returns:
-            dict with ``token`` (used to connect to the live chart),
+        Returns
+        -------
+        dict with ``token`` (used to connect to the live chart),
             ``job_id`` and ``model_id``.
         """
         payload = {"model_id": model_id, "seed": seed}
@@ -179,8 +205,9 @@ class FmResource:
     def job_status(self, job_id: str) -> dict:
         """Foundation-model job status.
 
-        Returns:
-            dict with job_id, ``status``, ``message``, ``detail``,
+        Returns
+        -------
+        dict with job_id, ``status``, ``message``, ``detail``,
             ``started_at`` and ``completed_at``. ``status`` is one of queued,
             provisioning, starting, running, complete or failed — only the
             last two are terminal (see TERMINAL_STATUSES), so poll until one
@@ -193,7 +220,8 @@ class FmResource:
     def job_logs(self, job_id: str) -> dict:
         """Foundation-model job pod logs.
 
-        Returns:
-            dict with ``logs`` — the thing to read when a job failed.
+        Returns
+        -------
+        dict with ``logs`` — the thing to read when a job failed.
         """
         return self._client._request("GET", f"{JOBS_PATH}/{job_id}/logs")