pyargs — Create a Python keyword-argument bundle.
bundle = pyargs(name, value, ...) stores name-value pairs for a later py.* call. Bundle construction does not start Python.
Syntax
bundle = pyargs(name, value, ...)Inputs
name- Type
StringScalar- Required
- Yes
- Default
- —
- Description
- Nonempty keyword name.
value- Type
Any- Required
- Yes
- Default
- —
- Description
- Value retained in the keyword bundle.
Returns
bundle- Type
Any- Description
- RunMat.PythonArguments object with Names and Values cells.
Returned values from pyargs depend on how many outputs the caller requests.
Errors
RunMat:Foreign:InvalidCall- When
- Arguments do not satisfy the Python interoperability contract.
- Message
Invalid Python interoperability operation.
Inputs and result
Names must be nonempty text and arguments must occur in pairs. Values are retained without Python conversion until the bundle is used by a Python call. The result is a RunMat.PythonArguments value object with Names and Values cell properties.
Execution
Construction is local, works without a CPython service (including in a browser session), and does not create a Python foreign handle. Using the bundle with py.* requires an available session Python service.
Example
Create a keyword bundle
kw = pyargs('rel_tol', 0.00001);
kw.NamesUsing pyargs with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how pyargs changes the result.
Run a small pyargs example, explain the result, then change one input and compare the output.
FAQ
Does pyargs start Python?⌄
No. It only stores keyword names and values; conversion happens when a Python call consumes the bundle.
Related Interop functions
Native
calllib · clibgen.buildInterface · libfunctions · libisloaded · libpointer · libstruct · loadlibrary · setdatatype · unloadlibrary
Java
isjava · javaaddpath · javaArray · javaclasspath · javaMethod · javaMethodEDT · javaObject · javaObjectEDT · javarmpath · jenv · usejava
Related guides
Source you can read
Every RunMat function's source is public. Read exactly how pyargs is executed, line by line, in Rust.
- View the source for pyargs in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.