AxonX Studio
English · 简体中文
AxonX Studio is the browser workspace for AxonX. Use an Agent to develop research plugins, submit Tasks to a selected service, and inspect logs, artifacts, and charts. The backend runs Tasks; plugins provide the algorithms.
The home screenshot uses the English interface in the static Playground. Its data and execution are simulated.
Features
| Area | Capabilities |
|---|---|
| Task definitions | Configure installed Tasks, run them through the CLI Job, and inspect output fields and live logs. |
| Task management | Filter records, inspect configuration, follow progress and logs, and view dependencies and parent/child calls. Research indexes support deleting selected results. |
| Machines | Switch between local and configured remote targets; inspect CPU, memory, GPU, and runtime information. |
| Workspace | Browse the workspace from System management, preview paginated Parquet data, and switch Markdown between rendered preview and original source with frontmatter metadata. |
| Research results | Inspect ETL datasets, factor metrics, training configuration and curves, and prediction artifacts. |
| Backtests and comparison | View return curves, quality metrics, holdings, and yearly/quarterly/monthly summaries; compare two backtests over their common date window. |
| Agent | Stream responses and tool calls, resume conversations, rename/tag/fork/delete sessions, and stop the current turn. |
| API interfaces | Browse the selected machine's Job catalog and call APIs through schema-based forms. |
The interface supports English and Simplified Chinese, light/dark themes, and saved browser preferences. Hash routes preserve the selected machine and resource, for example #local/task-defs/catalog/demo.
Install and start
Use an activated Python environment with Python 3.12+. Local Task execution is supported on macOS and Linux. Prebuilt Studio packages require no Node.js or frontend build.
pip install "axonx[studio]"
export AXONX_SERVICE_TOKEN='replace-with-your-local-service-token'
axonx app --service.host 127.0.0.1
Open http://127.0.0.1:1024/. In Settings → Local service token, enter the same token and apply it. Studio saves the token in browser local storage and sends it as a Bearer token on API requests. Use the same settings form to replace or clear it.
You can also place AXONX_SERVICE_TOKEN in a .env file in the directory where you start AxonX. The CLI loads this file automatically; existing environment variables take precedence. See example.env for optional provider settings.
If AxonX is already installed, add Studio separately:
pip install axonx-studio
Restart the service after installation. AxonX loads dist/ through the package's static_dir() function and serves the UI at / when service.web_enabled is enabled.
Run your first task
- Open Task definitions, select
demo, enterx = 2andy = 3, and click Run task. - Studio opens the Task once its record appears. Inspect its configuration, steps, logs, and relationships.
- The execution monitor stays available across page and machine changes. Use it to return to the original execution.
Studio streams the existing cli Job until execution finishes. Navigation within Studio preserves the connection; reloading, closing the page, or losing the connection may stop the command. String arrays use add/remove controls, while objects and complex arrays use JSON fields. CLI execution (axonx exec --task demo --x 2 --y 3) and Agent execution remain available.
Leave Task Name empty to generate a name for each experiment. Reusing a fixed name replaces the directory of a finished run. Upstream relationships record lineage; the graph does not automatically execute dependent Tasks.
Input dependencies use upstream_task_ids, an array of direct upstream Task IDs. The dependency graph shows upstream/downstream links. Task details show both execution steps and parent/child invocations from children; those calls do not create dependency edges automatically.
Optional research and Agent setup
- Research plugins: install
axonx-qlib-a158,axonx-qlib-factor, oraxonx-qlib-strategyin the execution service's Python environment, then restart the service. Research views need completed runs with standardmetadata.jsonand artifact outputs. - Tushare downloads: configure
AXONX_TUSHARE_TOKENon the backend. OverrideAXONX_TUSHARE_BASE_URLonly when using a compatible custom endpoint. - Agent: configure the backend's
CLAUDE_CODE_API_KEY,CLAUDE_CODE_BASE_URL, andCLAUDE_CODE_MODEL_NAMEas needed for your provider. Ordinary Tasks can run without model credentials. Stopping an Agent turn does not cancel a Task it submitted. - Remote machines: configure backend service
targets, then select the target in Studio. The browser authenticates to the local service; the backend resolves remote addresses and credentials and forwards requests usingtarget.
See research setup, Agent configuration, and remote machines.
Research with an Agent
Give an external or built-in Agent your research question and the AxonX Skill. For built-in development, configure source access and file/command tools; see Agent setup. Develop the plugin, install it in the selected service, then submit Tasks and wait for upstream success.
The Qlib Alpha158 reference workflow is ETL → Train → Predict → Backtest, with factor analysis branching from ETL. qlib_a158, qlib_factor, and qlib_strategy provide the baseline, optional factors, and portfolio policies. When comparing runs, retain code, data, windows, parameters, costs, and Task IDs and start times. See research workflow.
npm distribution and static hosting
The npm package distributes the built frontend assets:
npm install @flowllm-ai/axonx-studio
Serve node_modules/@flowllm-ai/axonx-studio/dist/ with your static server. An AxonX backend is still required. The frontend uses origin-relative API URLs, so configure the same origin to proxy /health, /jobs, /upload, /mcp, and /proxy to that backend. Preserve Authorization headers and SSE streaming for live logs and Agent responses. Hash routing does not require server routes for individual Studio pages.
For AxonX's built-in hosting, install the Python package instead.
Develop from source
The frontend toolchain requires Node.js 22.x ≥ 22.13.0, 24.x, or 26+, as declared in package.json. Run the following from the repository root to install the backend and development dependencies:
pip install -e '.[dev]'
export AXONX_SERVICE_TOKEN='replace-with-your-local-service-token'
axonx app --service.host 127.0.0.1
In another terminal:
cd axonx_studio
npm ci
npm run dev
Open http://localhost:4173/ and configure the service token for this browser origin. Vite provides hot updates and proxies API requests to http://127.0.0.1:1024 by default.
To use a different backend:
AXONX_DEV_SERVER=http://127.0.0.1:2048 npm run dev
Vite also reads .env files from the repository root. Restart Vite after changing AXONX_DEV_SERVER. This setting controls the development proxy; it does not configure the backend URL in a production build.
Build and install local assets
# From axonx_studio/
npm run build
cd ..
pip install ./axonx_studio
build runs TypeScript checks and writes the static site to dist/. Restart AxonX to serve the installed package. After frontend changes, rebuild and reinstall to update the packaged assets.
Command (in axonx_studio/) |
Purpose |
|---|---|
npm run dev |
Start the Vite development server on port 4173 with API proxies. |
npm run build |
Type-check and produce dist/. |
npm run preview |
Preview a production build locally; backend proxying is only configured for the development server. |
npm run test |
Run the Vitest suite. |
npm run lint |
Run ESLint. |
npm run format:check |
Check formatting with Prettier. |
npm run format |
Apply Prettier formatting. |
npm pack and npm publish run the prepack build automatically. Python packaging includes existing dist/ assets; build them before creating a Python distribution.
Code organization
app/ coordinates routing and the shell. features/ contains seven business domains: Tasks (including definitions and graph), runtime (including machines and maintenance), Agent, workspace, research, operations, and the API catalog. Research separates selection, result presentation and calculations. Operations owns online and comparison reports. shared/api/ owns transport, generated wire types, file decoding and artifact access; shared/hooks/ owns cancellable resources, refresh scheduling and chart lifecycle.
Use function components for React UI, pure functions for transformations, and classes where state has an explicit owner: AxonXClient, ArtifactTableCache, SignalHistoryStore, and the refresh scheduler. Old module paths and forwarding wrappers are removed. Import wire types directly from shared/api/contracts.ts; this generated file remains tied to the backend contract.
All requests use separate business arguments and { target, signal } options. Task identity includes its start time; input dependencies and parent/child invocation remain separate. A failed refresh preserves previously loaded data only within the same resource identity. Shared UI components and their consumers use the current interfaces directly.
See the complete file-by-file capability map, including every source, test, stylesheet, configuration file and source asset.
Troubleshooting
| Symptom | Check |
|---|---|
| Backend runs but Studio is unavailable | Install axonx-studio, verify dist/index.html exists for source builds, enable service.web_enabled, and restart the service. |
| Page loads but APIs return 401 | Match the browser's service token to AXONX_SERVICE_TOKEN; separate browser origins have separate saved tokens. |
| Task or API catalog is empty | Configure the backend service token, verify the selected machine, and install its plugins. Auth-required Jobs are omitted when the service has no token. |
| Development API requests fail | Check that the backend is running and AXONX_DEV_SERVER is correct; restart Vite after changes. |
| Research results or curves are missing | Inspect task status/logs and metadata.json; check output_params.artifacts, training_curve, and backtest daily/summary files as applicable. |
| Remote requests fail | Check backend targets, remote service credentials, and connectivity from the local backend. |
| Static deployment loads but APIs or streams fail | Check same-origin API proxy paths, Authorization forwarding, and SSE buffering. |
Workspace preview uses paths relative to the execution workspace. The /upload API handles staged uploads and cleanup; retrieve complete artifacts from the execution machine's workspace. Deleting runs or workspace entries removes their data and does not rebuild downstream results.
Documentation and license
Released under the Apache License 2.0.
Metadata
Release files for axonx-studio 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| axonx_studio-0.3.0.tar.gz | 490.4 kB | With provenance | Details for axonx_studio-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| axonx_studio-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for axonx_studio-0.3.0-py3-none-any.whl |
Total release size: 1.0 MB
Release files / axonx_studio-0.3.0.tar.gz
| Download URL | axonx_studio-0.3.0.tar.gz |
|---|---|
| Size | 490.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a262ea05a35eccc57298ef8d9a291e8e98da12816972260e78d8cb9bdcc3d97c
|
|
BLAKE2b-256 checksum How to use checksums |
63f6da8501b57990f916853b86439c65edd09d1cbc83a2ca075aa41b60fd892a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logRelease files / axonx_studio-0.3.0-py3-none-any.whl
| Download URL | axonx_studio-0.3.0-py3-none-any.whl |
|---|---|
| Size | 510.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9786d8bdc449bedd7a7b51ce0ba404680e5ad834b310e200e5a2294dc85fcb7a
|
|
BLAKE2b-256 checksum How to use checksums |
aec8c5aa6baf232d285c2b254b1e02d2a5d789fb166769762d557c6a237872a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logSecurity for axonx-studio 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for axonx_studio-0.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.