Référence de la documentation QuantCraft

QuantCraft propose deux types de documentation complémentaires : des rubriques intégrées que vous lisez dans l'IDE, et un Markdown de référence de stratégie fourni avec le produit pour le détail de l'API. Ensemble, ils décrivent comment écrire des stratégies, exécuter des backtests et utiliser l'IDE. Cette documentation web reprend bon nombre de ces rubriques — commencez par l'Introduction ou Premiers pas.

---

Où lire la documentation dans l'application

1. Ouvrez QuantCraft depuis l'application principale.
2. Développez la barre latérale droite (si elle est réduite).
3. Ouvrez l'onglet Documentation (à côté de QuantCraft AI).

Vous arrivez sur un index consultable des rubriques. Saisissez du texte dans la zone de recherche pour filtrer par titre, résumé ou mots-clés intégrés (par exemple on_finish, PaperAccount, chart_indicator_series).

Touchez une carte de rubrique pour ouvrir l'article complet. Utilisez Back pour revenir à l'index.

---

Index des rubriques (dans l'application)

Les rubriques sont regroupées en deux sections, comme dans la barre latérale Documentation.

Getting started

Reference

Toute carte de l'index qui n'ouvre pas encore d'article complet porte la mention Soon dans l'interface.

---

Lien entre la documentation intégrée et votre flux de travail

Utilisez cette carte rapide lorsque vous faites quelque chose dans l'IDE :

Les articles intégrés s'adressent aux auteurs de stratégies et aux utilisateurs de l'IDE. La mise en place côté serveur de QuantCloud n'est pas couverte par cette documentation publique.

---

Imports de stratégie

Écrivez chaque import sous la forme quantcraft.*, avec des noms de modules sans suffixe (par exemple quantcraft.inputs, pas quantcraft.inputs_module). Les anciens chemins ide.* et quantcraft.*_module fonctionnent toujours, tout comme quantcraft.backtest.* — l'ancien nom du paquet avant qu'il ne soit renommé quantcraft.process.* — de sorte que les stratégies existantes continuent de fonctionner sans changement — mais n'écrivez pas de nouveau code avec eux.

Des réexportations plus courtes fonctionnent aussi : quantcraft.indicator_series, quantcraft.account. Pour Fama-French, préférez from quantcraft import fama_french et lisez fama_french.qc dans les callbacks.

Accès aux lignes Fama-French : dataset["rows"] est un dict YYYYMM → valeurs, pas une liste. Utilisez .row(...) ou .rows_chronological(...) ; latest_row(...) uniquement dans les exécutions forward (en backtest, c'est de l'anticipation — voir Facteurs Fama-French). N'utilisez pas rows[0] / rows[-1].

N'utilisez pas de paquets internes comme quantcraft.b2.* (la couche de téléchargement de données derrière les chargeurs de prix et de données fondamentales) ni quantcraft.ai_assistant.* dans les scripts de stratégie — ce sont des assistants internes, pas l'API de stratégie. Ne confondez pas quantcraft.process.ohlcv (API OHLCV de stratégie) avec quantcraft.b2.ohlcv (couche de données interne).

Assistants transversaux

quantcraft.cross_sectional propose des assistants vectorisés pour comparer de nombreux symboles à la fois (numpy) : stack_field, latest_return, latest_sma, latest_std, latest_rsi, rank, zscore, demean, winsorize, ainsi que ColumnarBarArena.

Exécutions forward / en masse uniquement, tel qu'écrit. En backtest, rt.qc_ohlcv_by_symbol contient la plage complète chargée de chaque symbole ; « le dernier » y désigne donc la dernière barre du test — de l'anticipation. En backtest, collectez plutôt les clôtures de chaque symbole depuis sa bar au fil du parcours et transmettez ces tableaux aux assistants.

Poignées de module et noms importés

quantcraft.process.runtime et quantcraft.fama_french sont des alias de module ; l'accès par attribut lit donc la valeur courante de la session :

Tout le reste réexporte des noms par valeur : from ... import <name> lie donc un instantané pris à l'import.

Pour les handles que le moteur affecte à chaque exécution, il relie ces noms dans le fichier d'algo racine après l'avoir chargé ; la forme from ... import y est donc sûre — pour les noms qu'il relie :

• Backtest / Debug Test : account, chart_indicators, get_bar, qc_ohlcv, qc_ohlcv_by_symbol, qc_ohlcv_by_tf, qc_fundamentals, qc_fama_french, qc_calendar.
• Exécutions forward : seulement account, qc_fundamentals et qc_fama_french — pour chart_indicators et les handles OHLCV, utilisez donc rt.<name> dans ce cas.

Un module d'aide séparé est différent : il reste en cache dans sys.modules d'une exécution à l'autre dans le même processus ; un nom importé conserve donc le handle de la session courante lors du premier import — périmé pour l'exécution suivante (forward / en masse). Dans les modules d'aide, importez le module et utilisez l'accès par attribut :

from quantcraft.inputs import params est l'exception : params est un seul objet vivant dont les valeurs changent à chaque exécution, donc la forme from est sûre partout — voir Paramètres d'entrée.

---

Référence de stratégie fournie (Markdown)

Pour le comportement des modules ligne par ligne, les contrats des callbacks et les détails du moteur, le produit inclut aussi du Markdown dans le lot quantcraft-dev (conceptuellement : « référence de stratégie QuantCraft »). Une table des matières typique ressemble à ceci :

Ces fichiers s'adressent aux auteurs de stratégies qui ont besoin des noms et contrats exacts. Les sujets avancés comme BACKTEST_MODULE (point d'entrée WebSocket du backtest) et IDE_BACKTEST_RUNNER (exécuteur en sous-processus) sont inclus dans le lot pour les contributeurs mais ne sont pas des parcours utilisateur principaux. QuantCraft AI dans l'IDE est préchargé avec ce contenu afin que les réponses restent alignées sur les modules livrés.

---

Autres surfaces d'aide dans QuantCraft

Elles ne font pas partie de l'onglet Documentation mais appartiennent au même « écosystème de référence » pour les utilisateurs :

• QuantCraft AI — Posez des questions en langage naturel ; les réponses peuvent citer le même corpus de développement. Connectez un modèle dans AI → API Providers (votre propre clé, ou QuantCraft Premium / options hébergées).
• Import et export — Déplacez des fichiers .py (et associés) entre le disque et l'espace de travail.
• Résultats des tests — Graphique de capital, métriques, opérations et export HTML après un backtest.

---

Conseils de recherche

• Préférez des jetons courts qui apparaissent dans le code : on_finish, params, chart_indicator_series, coerce_chart_time, pane_id.
• Si rien ne correspond, effacez la recherche — l'index liste chaque rubrique par section.
• Les idées transversales (par exemple « données fondamentales + on_bar ») nécessitent souvent deux articles : ouvrez Données fondamentales pour la forme des données, puis Cycle de vie de la stratégie pour savoir quand elles sont disponibles.

---

Historique du document

La documentation intégrée est maintenue en même temps que le runtime des stratégies. Lorsque les modules Python ou la charge utile du backtest changent, les rubriques intégrées et le Markdown fourni sont mis à jour ensemble pour que les exemples et les noms restent synchronisés. Les exemples d'import de stratégie sont écrits partout avec des chemins quantcraft.* sans suffixe ; les anciens chemins ide.*_module et quantcraft.*_module ne sont documentés que comme aide à la lecture des scripts existants.