mlquantx 0.2.5__tar.gz → 0.2.6__tar.gz

{mlquantx-0.2.5/src/mlquantx.egg-info → mlquantx-0.2.6}/PKG-INFO

@@ -1,13 +1,15 @@
 Metadata-Version: 2.4
 Name: mlquantx
-Version: 0.2.5
+Version: 0.2.6
 Summary: Reference implementation of ‘ML-Enhanced Multi-Factor Quantitative Trading’ (arXiv:2507.07107).
 Author: Yimin Du
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/initial-d/ml-quant-trading
+Project-URL: Source, https://github.com/initial-d/ml-quant-trading
 Project-URL: Documentation, https://initial-d.github.io/ml-quant-trading/
 Project-URL: Paper, https://arxiv.org/abs/2507.07107
 Project-URL: Issues, https://github.com/initial-d/ml-quant-trading/issues
+Project-URL: Discussions, https://github.com/initial-d/ml-quant-trading/discussions
 Project-URL: Changelog, https://github.com/initial-d/ml-quant-trading/blob/main/CHANGELOG.md
 Keywords: quant,alpha,factor,portfolio,pytorch,markowitz
 Classifier: Development Status :: 4 - Beta
@@ -74,6 +76,22 @@ training, portfolio construction, cost-aware backtesting, and Markdown/JSON
 report generation. The default config ships inside the wheel, so the command
 works outside a repository checkout.
 
+## Customize or contribute
+
+The wheel is the fastest way to try the project. Clone the repository when you
+want to change factors, models, portfolio constraints, data sources, or
+backtest assumptions:
+
+```bash
+git clone https://github.com/initial-d/ml-quant-trading.git
+cd ml-quant-trading
+python -m pip install -e '.[dev]'
+```
+
+If the demo saves you setup time, consider
+[starring the repository](https://github.com/initial-d/ml-quant-trading) or
+[sharing a reproducible run](https://github.com/initial-d/ml-quant-trading/issues/new?template=reproduction_report.yml).
+
 ## What is included
 
 - 204 hand-crafted factors plus 9 curated Alpha101-style factors

{mlquantx-0.2.5 → mlquantx-0.2.6}/PYPI_README.md

@@ -21,6 +21,22 @@ training, portfolio construction, cost-aware backtesting, and Markdown/JSON
 report generation. The default config ships inside the wheel, so the command
 works outside a repository checkout.
 
+## Customize or contribute
+
+The wheel is the fastest way to try the project. Clone the repository when you
+want to change factors, models, portfolio constraints, data sources, or
+backtest assumptions:
+
+```bash
+git clone https://github.com/initial-d/ml-quant-trading.git
+cd ml-quant-trading
+python -m pip install -e '.[dev]'
+```
+
+If the demo saves you setup time, consider
+[starring the repository](https://github.com/initial-d/ml-quant-trading) or
+[sharing a reproducible run](https://github.com/initial-d/ml-quant-trading/issues/new?template=reproduction_report.yml).
+
 ## What is included
 
 - 204 hand-crafted factors plus 9 curated Alpha101-style factors

{mlquantx-0.2.5 → mlquantx-0.2.6}/README.md

@@ -22,10 +22,10 @@ Languages: [English](README.md) | [简体中文](README.zh-CN.md) | [繁體中
 · [**See cost-aware results**](docs/validation_dashboard.md)
 · [**Read the paper**](https://arxiv.org/abs/2507.07107)
 
-> **New in v0.2.5 — install from PyPI and run from any directory.**
+> **New in v0.2.6 — PyPI-to-GitHub contributor path.**
 > The distribution is published as `mlquantx`; the Python import package and
-> command remain `mlquant`. `mlquant demo` ships with its deterministic
-> configuration, preserving the zero-account factor-to-backtest path.
+> command remain `mlquant`. The demo now links successful runs back to the
+> source, reproduction form, and next contribution steps.
 
 ---
 
@@ -55,6 +55,15 @@ mlquant demo
 No market-data account is required. The deterministic demo prints each pipeline
 stage and writes a shareable Markdown/JSON report.
 
+Ready to modify factors, models, data sources, or backtest assumptions? Switch
+from the packaged demo to a source checkout:
+
+```bash
+git clone https://github.com/initial-d/ml-quant-trading.git
+cd ml-quant-trading
+python -m pip install -e '.[dev]'
+```
+
 ## Fast Path
 
 | If you want to... | Start here | What you get |
@@ -114,7 +123,7 @@ Successful and failed runs are both useful and credited.
 **Other current calls for contributors**
 
 - Join the [August 2026 reproduction challenge](https://github.com/initial-d/ml-quant-trading/discussions/43): run Colab once, then use the [structured report form](https://github.com/initial-d/ml-quant-trading/issues/new?template=reproduction_report.yml), whether it succeeds or fails.
-- Try the [`v0.2.5` release](https://github.com/initial-d/ml-quant-trading/releases/tag/v0.2.5).
+- Try the [`v0.2.6` release](https://github.com/initial-d/ml-quant-trading/releases/tag/v0.2.6).
 - Read the [Research Card](docs/research_card.md) for intended use, current evidence, and non-goals.
 - Read the [public-data mini reproduction](docs/public_data_mini_reproduction.md).
 - Share benchmark or public-data results in [Discussions #13](https://github.com/initial-d/ml-quant-trading/discussions/13).

{mlquantx-0.2.5 → mlquantx-0.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mlquantx"
-version = "0.2.5"
+version = "0.2.6"
 description = "Reference implementation of ‘ML-Enhanced Multi-Factor Quantitative Trading’ (arXiv:2507.07107)."
 readme = "PYPI_README.md"
 requires-python = ">=3.9"
@@ -57,9 +57,11 @@ mlquant = "mlquant.cli.main:main"
 
 [project.urls]
 Homepage = "https://github.com/initial-d/ml-quant-trading"
+Source = "https://github.com/initial-d/ml-quant-trading"
 Documentation = "https://initial-d.github.io/ml-quant-trading/"
 Paper    = "https://arxiv.org/abs/2507.07107"
 Issues   = "https://github.com/initial-d/ml-quant-trading/issues"
+Discussions = "https://github.com/initial-d/ml-quant-trading/discussions"
 Changelog = "https://github.com/initial-d/ml-quant-trading/blob/main/CHANGELOG.md"
 
 [tool.setuptools.packages.find]

{mlquantx-0.2.5 → mlquantx-0.2.6}/src/mlquant/__init__.py

@@ -14,5 +14,5 @@ import torch or cvxpy. Sub-packages are loaded lazily on demand.
 """
 from __future__ import annotations
 
-__version__ = "0.2.5"
+__version__ = "0.2.6"
 __all__ = ["__version__"]

{mlquantx-0.2.5 → mlquantx-0.2.6}/src/mlquant/cli/main.py

@@ -30,6 +30,12 @@ from ..utils.config import load_config
 from ..utils.seed import seed_everything
 
 
+PROJECT_URL = "https://github.com/initial-d/ml-quant-trading"
+REPRODUCTION_REPORT_URL = (
+    f"{PROJECT_URL}/issues/new?template=reproduction_report.yml"
+)
+
+
 def _artifacts_dir(cfg) -> Path:
     p = Path(cfg.get("artifacts_dir", "artifacts"))
     p.mkdir(parents=True, exist_ok=True)
@@ -50,6 +56,8 @@ def _write_backtest_summary(
     }
     payload = {
         "project": "ml-quant-trading",
+        "repository": PROJECT_URL,
+        "reproduction_report": REPRODUCTION_REPORT_URL,
         "workflow": "synthetic factor-to-backtest demo",
         "config": config_path,
         "costs_bps": float(costs_bps),
@@ -78,6 +86,11 @@ def _write_backtest_summary(
             f"- Config: `{config_path}`",
             f"- Transaction cost assumption: `{costs_bps:g} bps`",
             "- Workflow: synthetic data → 213 factors → MLP → Markowitz → backtest",
+            f"- Source: [{PROJECT_URL}]({PROJECT_URL})",
+            (
+                "- Share a reproducible run: "
+                f"[open the report form]({REPRODUCTION_REPORT_URL})"
+            ),
             "",
             "| Metric | Value |",
             "|---|---:|",
@@ -137,6 +150,10 @@ def _run_demo(ctx: click.Context, config_path: str) -> None:
         ctx.invoke(command, config_path=config_path)
         click.echo()
     click.echo("Demo complete. Inspect the backtest summary above and artifacts/ for outputs.")
+    click.echo("\nNext steps")
+    click.echo(f"  Customize or inspect the source: {PROJECT_URL}")
+    click.echo(f"  Share a reproducible run:       {REPRODUCTION_REPORT_URL}")
+    click.echo("  If this saved you setup time, consider starring the repository.")
 
 
 @cli.command("gen-data")

{mlquantx-0.2.5 → mlquantx-0.2.6/src/mlquantx.egg-info}/PKG-INFO

@@ -1,13 +1,15 @@
 Metadata-Version: 2.4
 Name: mlquantx
-Version: 0.2.5
+Version: 0.2.6
 Summary: Reference implementation of ‘ML-Enhanced Multi-Factor Quantitative Trading’ (arXiv:2507.07107).
 Author: Yimin Du
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/initial-d/ml-quant-trading
+Project-URL: Source, https://github.com/initial-d/ml-quant-trading
 Project-URL: Documentation, https://initial-d.github.io/ml-quant-trading/
 Project-URL: Paper, https://arxiv.org/abs/2507.07107
 Project-URL: Issues, https://github.com/initial-d/ml-quant-trading/issues
+Project-URL: Discussions, https://github.com/initial-d/ml-quant-trading/discussions
 Project-URL: Changelog, https://github.com/initial-d/ml-quant-trading/blob/main/CHANGELOG.md
 Keywords: quant,alpha,factor,portfolio,pytorch,markowitz
 Classifier: Development Status :: 4 - Beta
@@ -74,6 +76,22 @@ training, portfolio construction, cost-aware backtesting, and Markdown/JSON
 report generation. The default config ships inside the wheel, so the command
 works outside a repository checkout.
 
+## Customize or contribute
+
+The wheel is the fastest way to try the project. Clone the repository when you
+want to change factors, models, portfolio constraints, data sources, or
+backtest assumptions:
+
+```bash
+git clone https://github.com/initial-d/ml-quant-trading.git
+cd ml-quant-trading
+python -m pip install -e '.[dev]'
+```
+
+If the demo saves you setup time, consider
+[starring the repository](https://github.com/initial-d/ml-quant-trading) or
+[sharing a reproducible run](https://github.com/initial-d/ml-quant-trading/issues/new?template=reproduction_report.yml).
+
 ## What is included
 
 - 204 hand-crafted factors plus 9 curated Alpha101-style factors

{mlquantx-0.2.5 → mlquantx-0.2.6}/tests/test_cli.py

@@ -39,6 +39,9 @@ def test_demo_runs_pipeline_stages_in_order(monkeypatch, tmp_path):
     ]
     assert all(path == str(config) for _, path in calls)
     assert "Demo complete" in result.output
+    assert "https://github.com/initial-d/ml-quant-trading" in result.output
+    assert "reproduction_report.yml" in result.output
+    assert "consider starring" in result.output
 
 
 def test_demo_is_visible_in_cli_help():
@@ -88,8 +91,12 @@ def test_backtest_summary_is_shareable_and_strict_json(tmp_path):
     assert payload["metrics"]["sharpe"] == 1.25
     assert payload["metrics"]["sortino"] is None
     assert payload["costs_bps"] == 5.0
+    assert payload["repository"] == "https://github.com/initial-d/ml-quant-trading"
+    assert payload["reproduction_report"].endswith("reproduction_report.yml")
 
     markdown = markdown_path.read_text()
     assert "| `sharpe` | 1.250000 |" in markdown
     assert "| `sortino` | n/a |" in markdown
     assert "not investment advice" in markdown
+    assert "https://github.com/initial-d/ml-quant-trading" in markdown
+    assert "open the report form" in markdown