cnhkmcp 2.1.2__tar.gz → 2.1.3__tar.gz

{cnhkmcp-2.1.2/cnhkmcp.egg-info → cnhkmcp-2.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cnhkmcp
-Version: 2.1.2
+Version: 2.1.3
 Summary: A comprehensive Model Context Protocol (MCP) server for quantitative trading platform integration
 Home-page: https://github.com/cnhk/cnhkmcp
 Author: CNHK

{cnhkmcp-2.1.2 → cnhkmcp-2.1.3}/cnhkmcp/untracked/AI/346/241/214/351/235/242/346/217/222/344/273/266/config.json

@@ -1,5 +1,5 @@
 {
-    "api_key": "",
+    "api_key": "sk-lCfgrezCmn15J4VNkQb4n7pHYH2lKDQ82lj5Ehu6tOWoecPc",
     "base_url": "https://api.moonshot.cn/v1",
     "model": "kimi-latest",
     "system_prompt": "You are a WorldQuant BRAIN platform expert and Consultant. Your goal is to assist users with Alpha development, BRAIN API usage, and maximizing consultant income.\n\nYour expertise includes:\n- Deep knowledge of the BRAIN API (authentication, data, simulation, analysis).\n- Alpha development best practices (stable PnL, economic sense, avoiding pitfalls).\n- Consultant income structure (daily pay, Genius Program, increasing earnings).\n\nGuidelines:\n- Always refer to the BRAIN_Consultant_Starter_Handbook.md for guidance.\n- Emphasize the importance of stable PnL and economic sense when discussing Alphas.\n- Follow the handbook's workflow for API usage.\n- Explain income components clearly when asked.\n- IMPORTANT: You cannot directly interact with the platform. You must guide the user step-by-step on what actions to take (e.g., 'Copy this code', 'Go to the Simulation page').\n- Always suggest the specific next operation the user should perform.\n\nKey Concepts:\n1. Pyramid:\n   - Definition: Combination of Region + Delay + Data Category. 'Lit' when 3+ Alphas are submitted in that combo.\n   - Purpose: Measures diversity; affects promotions and QualityFactor.\n   - Tips: Target underfilled pyramids; use grouping fields; track via MCP.\n\n2. Simulation Settings:\n   - Key fields: instrument_type, region, delay (D0/D1), universe, neutralization, decay, truncation, etc.\n   - Best Practices: Preprocess (winsorize -> zscore) -> Neutralize. Validate exposures.\n   - Neutralization: Use regression_neut or group_neutralize. Consider CROWDING or RAM options.\n   - Universes: Choose based on investability (e.g., TOP3000, TOPSP500).\n\nIf the user provides a screenshot, analyze it in the context of the BRAIN platform (e.g., Alpha code, simulation results, error messages). Answer in Chinese."

{cnhkmcp-2.1.2 → cnhkmcp-2.1.3}/cnhkmcp/untracked/AI/346/241/214/351/235/242/346/217/222/344/273/266/get_knowledgeBase_tool/ace_lib.py

@@ -1243,6 +1243,10 @@ def get_datafields(
     for x in range(0, count, 50):
         for _ in range(max_try):
             datafields = s.get(url_template.format(x=x))
+            while datafields.status_code == 429:
+                print("status_code 429, sleep 3 seconds")
+                time.sleep(3)
+                datafields = s.get(url_template.format(x=x))
             if "results" in datafields.json():
                 break
             time.sleep(5)

cnhkmcp-2.1.3/cnhkmcp/untracked/AI/346/241/214/351/235/242/346/217/222/344/273/266/knowledge/001_10_Steps_to_Start_on_BRAIN_documentation.json

@@ -0,0 +1,14 @@
+{
+  "id": "10-steps-start-brain-platform",
+  "title": "10 Steps to Start on BRAIN",
+  "lastModified": "2025-03-12T05:07:54.001684-04:00",
+  "content": [
+    {
+      "type": "TEXT",
+      "value": "<p><b>10 Steps to Start on BRAIN</b></p><ol><li>Watch the <a href=\"https://platform.worldquantbrain.com/learn/courses/introduction-alphas\">“Introduction to Alphas”</a> training series</li><li>Read the <a href=\"https://platform.worldquantbrain.com/learn/documentation#:~:text=Documentation-,Discover%20BRAIN,-4%20Articles\">starter pack series</a> under “Discover BRAIN” section</li><li>Simulate three simple formulas using the data field: close and the operator: rank</li><li>Understand the simulation settings, starting with <a href=\"https://platform.worldquantbrain.com/learn/documentation/create-alphas/simulation-settings\">delay and neutralization</a> .</li><li>Click the Example button on the bottom left of the <a href=\"https://platform.worldquantbrain.com/simulate\">Simulate</a> page for examples. Try to improve these expressions using the Hint and then submit</li><li>Understand the <a href=\"https://platform.worldquantbrain.com/learn/documentation/interpret-results/parameters-simulation-results\">Simulation Results</a> and submission tests.</li><li>Simulate Alphas discussed in the \"Create Alphas\" sections <a href=\"https://platform.worldquantbrain.com/learn/documentation/create-alphas/running-your-first-alpha\">Run your First Alpha</a> and <a href=\"https://platform.worldquantbrain.com/learn/documentation/create-alphas/another-sample-alpha\">Another Sample Alpha</a>. Pay attention to the settings.</li><li>Check the <a href=\"https://platform.worldquantbrain.com/events\">Events</a> page to attend training webinars.</li><li>Read the <a href=\"https://support.worldquantbrain.com/hc/en-us/search?filter_by=community&amp;query=%5Bbrain+tips&amp;utf8=%E2%9C%93\">BRAIN TIPS series</a> and the <a href=\"https://support.worldquantbrain.com/hc/en-us/search?content_tags=01GVTJQR8518KQMHP1JMCZ4Y99&amp;utf8=%E2%9C%93\">Beginner</a> posts in FAQs/ Forums</li><li>Try to create Alphas using available <a href=\"https://platform.worldquantbrain.com/data/data-sets/pv1\">Price volume</a> data fields or and, <a href=\"https://platform.worldquantbrain.com/learn/data-and-operators/operators\">Operators</a></li></ol><p></p><p></p>",
+      "id": "9a93f80b-cd7e-4c54-8c1f-ce8365c6eb20"
+    }
+  ],
+  "sequence": 29,
+  "category": "Getting Started"
+}

cnhkmcp-2.1.3/cnhkmcp/untracked/AI/346/241/214/351/235/242/346/217/222/344/273/266/knowledge/001_Intermediate_Pack_-_Improve_your_Alpha_2_2_documentation.json

@@ -0,0 +1,174 @@
+{
+  "id": "intermediate-pack-part-2",
+  "title": "Intermediate Pack - Improve your Alpha [2/2]",
+  "lastModified": "2025-03-12T05:10:08.846145-04:00",
+  "content": [
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Use Different Operators"
+      },
+      "id": "54427cb7-0cde-4bf4-bcf7-34a3cfd937e4"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>Remember the cross-sectional operators and time-series operators from the <a href=\"$tutorialpage/discover-brain/read-first-starter-pack\">Starter pack</a>? You can use them here. Secondly, you can try out different data fields. We recommend exploring the price volume dataset, model dataset and fundamental dataset. Lastly, you can tinker with different simulation settings. These tips should help improve the performance of your second Alpha.</p><p><b>Divide (/)</b></p><p>We can divide data fields with other data fields.</p><p>Imagine market data being a matrix, with each row representing one date and each column representing one stock. For example, the matrix for close price data of stocks in universe US TOP3000 would look like this:</p>",
+      "id": "64f1ecaf-05a0-411d-af64-899183c320a6"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic3.png",
+        "width": 771,
+        "height": 152,
+        "fileSize": 39951,
+        "url": "https://api.worldquantbrain.com/content/images/zyZvfOxlAnwgdTTZ-B7UB9AVFc0=/241/original/pic3.png"
+      },
+      "id": "37bc8ee8-5d3e-49c8-a8c2-8f5d0081b676"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p>And the matrix for open data of above stocks would look like this:</p><p></p>",
+      "id": "c680c7c0-f1af-4a52-b66e-7a2f40023419"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic4.png",
+        "width": 771,
+        "height": 152,
+        "fileSize": 39898,
+        "url": "https://api.worldquantbrain.com/content/images/b_PTsgVo_U8vN0mZVDsXNWvw0Kk=/242/original/pic4.png"
+      },
+      "id": "8ad864b0-5015-4261-b7cf-4571cd682232"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>Say you enter an Alpha expression like <b><i>close/open</i></b> in the Simulate page found in the Alphas dropdown tab. When you click Simulate, BRAIN will evaluate the Alpha expression against the matrix of market data for each date and each stock.</p><p></p><p><b>Rank(x)</b></p><p>Description: the Rank operator ranks the value of the input data x for the given stock among all instruments, and returns float numbers equally distributed between 0.0 and 1.0</p><p>Alpha expression: <b><i>rank(sales/assets)</i></b>. If company B has a higher asset turnover ratio (sales/assets) than company A, stock B may outperform stock A. The rank operator helps to limit the extreme values of that ratio.</p><p>For example:</p>",
+      "id": "636fb046-195d-414d-9748-6089e8c864a9"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic5.png",
+        "width": 771,
+        "height": 84,
+        "fileSize": 15942,
+        "url": "https://api.worldquantbrain.com/content/images/5DyPSU56mesHoyLmobTGUGtGF6Q=/222/original/pic5.png"
+      },
+      "id": "d610082a-b347-4de4-9b3a-cd1352584e7c"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>The numbers imply that if you have $126, you must use $100 to go long stock E (~80% of your total capital). So, your strategy would depend crucially on how the last stock performs. But, isn’t that too risky? Applying the rank function to the alpha expression <b><i>rank(sales/assets)</i></b>, you get:</p>",
+      "id": "93e27c28-c79c-49bc-9727-d5b8d7473138"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic18.png",
+        "width": 771,
+        "height": 84,
+        "fileSize": 18443,
+        "url": "https://api.worldquantbrain.com/content/images/YrFJODUY_L-Tzube67j_76TriVk=/223/original/pic18.png"
+      },
+      "id": "c0607c73-dc92-4000-98fc-01413bf1e241"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>This time you see that the stock with the largest weight occupies only 40% of your portfolio.</p><p><b>Ts_rank &amp; Ts_delta Operator</b></p>",
+      "id": "fbab6eba-f8a1-4951-b040-92f6f497c60a"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic6.png",
+        "width": 771,
+        "height": 368,
+        "fileSize": 181983,
+        "url": "https://api.worldquantbrain.com/content/images/ZaDUxf6tcA4QYK2CTUc0QBCpGr0=/224/original/pic6.png"
+      },
+      "id": "d2865565-8c65-4b21-ad59-00f517fa3f2e"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p>Visual Illustration of Ts_rank Operator:</p>",
+      "id": "f72356fa-38d0-4210-9344-0714a80b8dab"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic7.png",
+        "width": 771,
+        "height": 502,
+        "fileSize": 96245,
+        "url": "https://api.worldquantbrain.com/content/images/jN-BbRAavK12pOvzlkizS2DfCms=/225/original/pic7.png"
+      },
+      "id": "751f28b4-6ee2-40ca-be1a-d93915c8ecfc"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Change Simulation Settings"
+      },
+      "id": "83727ba4-4027-4614-b958-43f4d41b3286"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>In your first Alpha simulation, you left the simulation settings on default. Changing certain simulation settings may help you improve your Alpha results. We will go through Region, Universe, Neutralization, Decay and Truncation. The other settings will be covered in a later guide.</p>",
+      "id": "bd4132a8-e82d-49b9-b22f-e23a31eb9b1b"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic8.png",
+        "width": 771,
+        "height": 453,
+        "fileSize": 57056,
+        "url": "https://api.worldquantbrain.com/content/images/WhHMxH-cWr_2qPP6vrblhP9QRPA=/226/original/pic8.png"
+      },
+      "id": "4d8cf368-10ef-4b0c-8be3-81b5dbed6e32"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p><b>Region</b></p><p>Region refers to the market in which the Alpha will simulate trades, for example, the U.S. equity market or Chinese equity market.</p><p><b>Universe</b></p><p>Universe is a set of trading instruments ranked by their liquidity. For example, “US: TOP3000” represents the top 3,000 most liquid stocks in the U.S. market.</p><p><b>Decay</b></p><p>Decay is used for averaging the Alpha signal within a specified time window. The settings perform linear decay on the Alpha. Tip: Decay can be used to reduce turnover, but decay values that are too large will attenuate the signal.</p><p></p>",
+      "id": "3a14c39c-991a-48eb-8394-a90fff967c65"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic9 (1).png",
+        "width": 677,
+        "height": 48,
+        "fileSize": 5531,
+        "url": "https://api.worldquantbrain.com/content/images/68s3CAL6Jmp2VQi-0-8SI4zVQFM=/217/original/pic9_1.png"
+      },
+      "id": "ca4d0b19-2dd8-4e0e-ad00-806cc386f994"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p><b>Truncation</b></p><p>Truncation sets the maximum weight for each stock in the overall portfolio. It aims to guard against excessive exposure to movements in individual stocks. The recommended setting is between 0.05 and 0.1 (entailing 5-10%).</p><p><b>Neutralization</b></p><p>Market risks and industry specific risks are prevalent risks within equities. However, these risks can be reduced by creating long-short neutral portfolios using a concept called neutralization. After neutralizing the portfolios to market or industry specific groups, no net position is taken with respect to that group, i.e. allotting the same amount of dollars in long (buying) and short (selling) positions. That way, you are less exposed to risk, whether the entire market goes up or down.</p><p>When Neutralization = “Market/Industry/Sub-industry” it does the following operation: <i>Alpha = Alpha – mean(Alpha)</i> where Alpha is the vector of weights.</p>",
+      "id": "03cb2eb3-1d97-4069-b934-1beec8f22afc"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic10.png",
+        "width": 771,
+        "height": 105,
+        "fileSize": 21736,
+        "url": "https://api.worldquantbrain.com/content/images/oe90T3rIXhTei2CRLQ83P4y2m0o=/227/original/pic10.png"
+      },
+      "id": "6971c126-fa53-4a02-9358-ce4fae976d2f"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>If the hypothetical book size is 20 million, we would end up investing $10 million in long positions and $10 million in short positions. Thus, no net position is taken with respect to the market. In other words, the long exposure cancels out the short exposure completely, making this hypothetical strategy market neutral.</p><p>The three different neutralization methods determine which groups are used for neutralizing Alpha values. The correct choice of neutralization depends on the logic or formula used by the Alpha. The results should indicate which neutralization will be most effective.</p>",
+      "id": "16919564-398f-4d20-b791-3887fd254515"
+    }
+  ],
+  "sequence": 5,
+  "category": "Getting Started"
+}

cnhkmcp-2.1.3/cnhkmcp/untracked/AI/346/241/214/351/235/242/346/217/222/344/273/266/knowledge/001_Intermediate_Pack_-_Understand_Results_1_2_documentation.json

@@ -0,0 +1,167 @@
+{
+  "id": "intermediate-pack-part-1",
+  "title": "Intermediate Pack - Understand Results [1/2]",
+  "lastModified": "2025-09-08T05:22:10.878298-04:00",
+  "content": [
+    {
+      "type": "TEXT",
+      "value": "<p>This Intermediate guide aims to further your understanding of the Alphas you have simulated. The documentation will provide you with an in-depth understanding of commonly used operators and get you up to speed to improve your ability to create a high-performing Alpha.</p>",
+      "id": "c75deabb-4eca-41f1-97eb-dc0f19e078c3"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Understanding Your Results"
+      },
+      "id": "c8f2dd55-d0ec-4328-adff-a093e0eb975b"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p><b>Cumulative PnL Chart</b></p>",
+      "id": "1cb8d31e-5349-43be-b7a3-c5b0633a0dee"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "Cumulative PnL Chart",
+        "width": 978,
+        "height": 870,
+        "fileSize": 116115,
+        "url": "https://api.worldquantbrain.com/content/images/GwEgi_phuPYB7VPoAsMSdEiuEcA=/424/original/Intermediate_Results_1_Graphs.png"
+      },
+      "id": "68018bb4-f0fc-46dc-a42f-2412ec767f87"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>If you’ve followed the examples in the Starter pack, chances are you’ve ended up with the first 2 graphs. What both graphs have in common is that they have multiple periods of significant losses, producing a graph with high fluctuations. This means that your simulated portfolio could lose a large percentage of its value in one day, and that wouldn’t be ideal. Rather, a good Alpha should produce a steadily rising PnL chart (3rd graph) with few fluctuations and no major drawdown.</p><p><b>In-sample (IS) Summary</b></p><p>In-sample simulation uses data over a 5-year timeframe, and tests out how well your Alpha performs in the historical period. After the simulation, you will see the IS Summary row with 6 metrics: Sharpe, Turnover, Fitness, Returns, Drawdown, and Margin.</p>",
+      "id": "4ee97111-7208-40b1-a5b4-7ca54e44e177"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic_155.png",
+        "width": 771,
+        "height": 121,
+        "fileSize": 39119,
+        "url": "https://api.worldquantbrain.com/content/images/KKvc6QqVmU1sEaOO6Wg6MsnBDc0=/243/original/pic_155.png"
+      },
+      "id": "ed503420-517b-4555-8a7b-f709cc062400"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p><b>Sharpe</b></p><p>This ratio measures the excess return (or risk premium) per unit of deviation of returns of an Alpha. It takes the mean of the PnL divided by the standard deviation of the PnL. The higher the Sharpe Ratio or Information Ratio (IR), the more consistent the Alpha’s returns are potentially likely to be, and consistency is an ideal trait. The passing requirement for Sharpe on BRAIN is to be above 1.25.</p>",
+      "id": "4c5a57df-a066-41c0-acdb-024f48785d08"
+    },
+    {
+      "type": "EQUATION",
+      "value": "Sharpe =\\sqrt{252} * \\left(\\frac{Mean(PnL)}{Stdev(PnL)}\\right)",
+      "id": "15e0c3a5-2b64-4f13-aeae-0cbec6c4f1ed"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p><b>Turnover</b></p><p>Turnover of an Alpha is metric that measures the simulated daily trading activity, i.e., how often the Alpha trades. It can be defined as the ratio of value traded to book size. The higher the turnover, the more often a trade occurs. Since trading incurs transaction costs, reducing turnover is generally an ideal trait. The passing requirement for turnover on BRAIN is to be between 1% and 70%.</p>",
+      "id": "5e9c6c2a-a2e2-4d99-9738-a851f5f237b1"
+    },
+    {
+      "type": "EQUATION",
+      "value": "Turnover= \\frac{Dollar Trading Value}{Booksize}",
+      "id": "ab857630-8460-424c-9a73-f1f49df7f90a"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p><b>Fitness</b></p><p>Fitness of an Alpha is a function of Returns, Turnover &amp; Sharpe. Fitness is defined as:</p>",
+      "id": "61cd8c36-fd6e-4e36-99df-701572d80a7b"
+    },
+    {
+      "type": "EQUATION",
+      "value": "Fitness =Sharpe *  \\sqrt{\\frac{abs(Returns)}{max(Turnover,0.125)}}",
+      "id": "56981411-da5f-46b5-96fd-70e30c093f40"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p>Good Alphas generally have high fitness. You can seek to improve the performance of your Alphas by increasing Sharpe (or returns) and reducing turnover. The passing requirement for fitness on BRAIN is to be greater than 1.0.</p><p><b>Returns</b></p><p>Returns is the amount made or lost by the Alpha during a defined period and is expressed in percentages. BRAIN defines returns as:</p>",
+      "id": "706cd07e-1ff9-49bc-bbf1-b9e5b9d8f59f"
+    },
+    {
+      "type": "EQUATION",
+      "value": "Annual Return = \\frac{Annualized PnL}{0.5 *  Book Size}",
+      "id": "679fca89-d850-4796-8308-fff5b5641dcf"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p><b>Drawdown</b></p><p>Drawdown of an Alpha is the largest reduction in simulated PnL during a given period, expressed as a percentage. It is calculated as follows:</p>",
+      "id": "d9b12c61-df74-42fc-8671-d1b8c584e804"
+    },
+    {
+      "type": "EQUATION",
+      "value": "Drawdown = \\frac {Dollar Amount Of Largest Peak To Trough Gap In PnL}{0.5 * Book Size}",
+      "id": "27f97417-6827-4651-a111-85ebb6c72644"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p><b>Margin</b></p><p>Margin is the simulated profit per dollar traded of an Alpha; calculated as:</p>",
+      "id": "30b92ca1-e80e-4f6d-8de0-16aaf35749cd"
+    },
+    {
+      "type": "EQUATION",
+      "value": "Margin = \\frac{PnL}{Total Dollars Traded}",
+      "id": "56405fdc-cc08-4b0f-872b-e4d8f64cfbbb"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Passing IS Stage and Troubleshooting"
+      },
+      "id": "e70bff92-8742-43ee-9f1d-7cffbe3ee246"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "pic2.png",
+        "width": 771,
+        "height": 311,
+        "fileSize": 57002,
+        "url": "https://api.worldquantbrain.com/content/images/lzw_pauL0IDC-LmLZSajF_zIzpA=/240/original/pic2.png"
+      },
+      "id": "cd7c1086-2a90-4977-a065-7f2e2af3e396"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><ul><li>One of the most common challenges users face is Low Sharpe, and users commonly see that their Sharpe ratio is below the specified cutoff. How do you get a higher Sharpe? We suggest that you can either increase you Alpha return or reduce your volatility. Read more <a href=\"https://support.worldquantbrain.com/hc/en-us/community/posts/8123350778391-How-do-you-get-a-higher-Sharpe-\">here</a>.</li><li>Another challenge is the weight test that measures the capital concentration in each stock. You might see these error messages in your IS tests: “Maximum weight on an instrument is greater than 10%” OR “Weight is too strongly concentrated” OR “Too few instruments are assigned weight.” Common fixes to this include: Adding range-normalized functions such as rank, setting truncation at 0.1, and using ts_backfill. Read more <a href=\"https://support.worldquantbrain.com/hc/en-us/community/posts/8419305084823--BRAIN-TIPS-Weight-Coverage-common-issues-and-advice\">here</a>.</li><li>Another difficulty is that the Sub-universe Sharpe is not above cutoff. This means that the Sharpe in the sub-universe must be higher than at least one threshold. There are 2 thresholds that scale down Sharpe with sub-universe size.</li></ul>",
+      "id": "d0a996d1-937b-4ac5-b34c-23c9640cc1aa"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "threshold main.PNG",
+        "width": 445,
+        "height": 109,
+        "fileSize": 8563,
+        "url": "https://api.worldquantbrain.com/content/images/9_dK9gcR2tOpkDKpj8bImpzlH0Q=/195/original/threshold_main.PNG"
+      },
+      "id": "3762f573-01e5-474e-ac59-497ee09d6060"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p>Thus, you can try to improve the Sub-Universe Sharpe by increasing the Universe of instruments (i.e. selecting Top3000).</p>",
+      "id": "e5b4444c-9089-48b8-b3de-2a5b678c86d7"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Common Error Messages"
+      },
+      "id": "2f95b268-20b6-4af5-b437-a1b9b863f265"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p><b>Syntax error in expression.</b></p><p>Check your spelling of the data fields and operators and ensure that your expression is logical. The tokens (operators and keywords) allowed in your Alpha expression can be found in the <a href=\"https://platform.worldquantbrain.com/data\">Available Market Data</a> and <a href=\"https://platform.worldquantbrain.com/learn/data-and-operators/operators\">Available Operators</a> pages. Alpha expressions also accept integers and floating point numbers.</p><p><b>Incompatible unit for input at index 0, expected \"Unit[]\", found \"Unit[CSPrice:1]\"</b></p><p>Unit warnings are provided for reference in simple cases and do not prevent submission. Usually, this warning appears when data fields having two different units are added or multiplied. E.g. if you add \"close\" to \"cap\". \"close\" has units of price but \"cap\" has units of price*shares. You can safely ignore these warnings if you're sure the Alpha correctly handles data units.</p>",
+      "id": "a30353f5-f89a-44e8-bbff-5975e5243522"
+    }
+  ],
+  "sequence": 4,
+  "category": "Getting Started"
+}

cnhkmcp-2.1.3/cnhkmcp/untracked/AI/346/241/214/351/235/242/346/217/222/344/273/266/knowledge/001_Introduction_to_Alphas_documentation.json

@@ -0,0 +1,145 @@
+{
+  "id": "about-brain-platform",
+  "title": "Introduction to Alphas",
+  "lastModified": "2025-09-12T03:33:37.870415-04:00",
+  "content": [
+    {
+      "type": "TEXT",
+      "value": "<p>BRAIN is a web-based tool for <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=operators.-,Backtesting,-Backtesting\">backtesting</a> trading ideas. An <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=A-,Alpha,-An\">Alpha</a> is a concrete trading idea that can be simulated historically.</p>",
+      "id": "2837a66e-2275-4bdd-9054-7a0206985413"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Alphas"
+      },
+      "id": "8ebed88c-ccb4-44f8-a173-bd42183f4471"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>In BRAIN, an 'Alpha' refers to a mathematical model, written as an expression, which places different bets (<a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=W-,Weight,-BRAIN\">weights</a>) on different <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=details.-,Instrument,-Instrument\">instruments</a> (stocks), and is expected to be profitable in the long run. After a user enters an Alpha expression that consists of data, <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=O-,Operator,-Operator\">operators</a> and constants, the input code is evaluated for each instrument to construct a portfolio. Then BRAIN makes investments in each instrument for a one-day period in proportion to the values of the expression. The process repeats each day.<br/></p>",
+      "id": "b71362d2-9fde-44ab-b868-0f2ff33765fb"
+    },
+    {
+      "type": "TEXT",
+      "value": "<iframe width=\"743\" height=\"333\" \" src=\"https://www.youtube.com/embed/A3RNoYAz_9U?start=66&end=192&feature=oembed&rel=0\" title=\"Learn2Quant: Creating a Quant Alpha | Lesson 2\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" allowfullscreen></iframe>",
+      "id": "1183498a-ba79-4a6b-8d47-efa2074d548c"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Alpha Lifecycle"
+      },
+      "id": "05ecc6cf-b9ac-4a9a-ad3b-d1f484785a06"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p>The flow chart below shows the lifecycle of an <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=A-,Alpha,-An\">Alpha</a>:</p>",
+      "id": "cd02587f-6908-4b44-99c4-e91214fffaf8"
+    },
+    {
+      "type": "TEXT",
+      "value": "<img src=https://api.worldquantbrain.com/content/images/sEX-vpQmh1uRWP-BIv3MVrsKI1k=/18/original/ alt=\"alpha_lifecycle\" width=\"700\">",
+      "id": "a13d02ab-05ee-4bb2-bf98-4ea146fc7984"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>First, one might peruse blogs, journals and research papers on the internet to come up with an idea. The Alpha expression is entered in BRAIN and operations (like truncation,neutralization, decay) are performed on the raw Alpha. BRAIN makes investments (goes long or short) for all the instrumentsof the universe chosen in the Settings panel and the PnL is simulated. Then the performance is calculated (Sharpe, Turnover, Returns) as seen in the Simulation Results page. And if the Alpha is not deemed worthy, the Alpha idea is revised. Else, it enters production.</p>",
+      "id": "c0efbee7-456e-4924-9a32-4b9c03b263a0"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Weights"
+      },
+      "id": "e35f3846-8adb-4337-b5e6-e95a57562e55"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>In simple terms, BRAIN uses an Alpha to create a vector of weights, with each weight corresponding to one of the stocks in the selected <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=U-,Universe,-Universe\">universe</a>. These weights may or may not be market neutralized, as per your <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=strategy.-,Neutralization,-Neutralization\">neutralization</a> setting (by market, industry, sub-industry or none). This creates a portfolio for each day in the simulation period, which can then be used to calculate that day's <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=consultants-,Profit%20and%20Loss%20(PnL),-Profit\">Profit and Loss (PnL)</a>.</p>",
+      "id": "efbe2911-6063-46b2-8519-3ee6a629c61c"
+    },
+    {
+      "type": "TEXT",
+      "value": "<iframe width=\"743\" height=\"333\" src=\"https://www.youtube.com/embed/A3RNoYAz_9U?start=193&end=262\" title=\"Long Short Neutrality\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" allowfullscreen></iframe>",
+      "id": "3bf6a5f9-88d3-46f0-a9f3-fcc412ead243"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Assigning weights"
+      },
+      "id": "49b1a6dd-e76b-4523-b7af-437774eac8eb"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>Suppose in the Expression box, you type in 1/close, and set the simulation settings as follows: <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=details.-,Region,-Set\">Region</a> = US, Universe = TOP3000, Delay = 1, Decay = 0, Neutralization = None, Truncation = 0. Now, once you hit \"Simulate\" button, then for each day in the Simulation Duration (5 years), the simulator does the following:<br/>It calculates 1/close (using the closing price for the previous day), for each <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=details.-,Instrument,-Instrument\">instrument</a> in the basket \"US: TOP3000\" (i.e. top 3000 stocks in the US, by market <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=level.-,Capitalization,-Daily\">capitalization</a>). This creates a vector of 3000 values (one for each stock). This vector is then normalized, i.e. divided by the sum of its values(so that all the values sum up to 1). This creates a vector of \"weights\" for all the stocks, which is called a \"Portfolio\". Each weight represents the fraction of money invested in that stock. If our <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=deviation.-,Booksize,-Booksize\">booksize</a> is $20 Million, then the money invested in each stock is $20M x (weight of that stock in the portfolio). This is done for each day in the simulation period, and at the end of each day the total profit or loss made by our portfolio is calculated.</p>",
+      "id": "edf3a2d7-3d8a-4235-9399-0897bfbaa466"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Positive and Negative weights"
+      },
+      "id": "c443631f-6a0d-4125-b09c-8807b6be4d8c"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>BRAIN assigns positive weights to indicate long positions in stocks, and negative weights to indicate short positions in stocks. The greater the magnitude of the weight on a stock, the larger the long or short position taken on it.</p><p>It is easy to invest $100 in stock, but negative positions (shorts) are common too. E.g. one can get $100 now by shorting a stock (i.e. investing -$100), which must be bought back later. PnL would be the opposite of $100 invested, as seen in the table below. Negative weights are called short positions and positive weights are called long positions. Typically investors take short positions when they expect stock price to decrease and long positions (i.e. buying stocks) when they expect price to increase. Please refer to <a href=\"http://www.investopedia.com/terms/s/shortselling.asp\">Investopedia</a> for more details on short selling.</p><p>The below table gives an example of payoffs from a $100 short and a $100 long position, for a 1% price change in each direction. For simplicity, it does not account for dividends, margin and financing costs.</p>",
+      "id": "499d70dc-d24f-459a-87f1-b8b29de7984d"
+    },
+    {
+      "type": "TABLE",
+      "value": {
+        "data": [
+          [
+            "Position",
+            "Name",
+            "PnL if stock price rises 1%",
+            "PnL if stock price falls 1%"
+          ],
+          [
+            "$100",
+            "Long",
+            "$1",
+            "-$1"
+          ],
+          [
+            "-$100",
+            "Short",
+            "-$1",
+            "$1"
+          ]
+        ],
+        "firstRowIsTableHeader": true,
+        "firstColIsHeader": false
+      },
+      "id": "2902048e-2053-4151-83dd-471bacd76722"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "BRAIN"
+      },
+      "id": "72d89a78-777a-4056-bd8e-6939260658a8"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>BRAIN is a web-based simulator of global financial markets that was created to explore Alpha research. It accepts an Alpha expression as input and plots its Profit and Loss (PnL) as output. The input expression is evaluated for each financial instrument, every day over historical dates, and a portfolio is constructed accordingly. BRAIN invests in each financial instrument according to the value of the expression. It takes positions (either buying or short selling) and assigns weights to each instrument. The weights are then scaled to book size (amount of money invested), based on which a PnL graph is plotted. These weights are not constant; they change over time based on current information and the history of the changes of some variables (such as prices, volumes, etc.).</p>",
+      "id": "c6d82411-29b3-4ea6-8b36-72caeed42e2b"
+    },
+    {
+      "type": "TEXT",
+      "value": "<img src=\"https://api.worldquantbrain.com/content/images/I_g6YAX-kKGKGKK6ygENw-q6C0I=/53/original/\" alt=\"alphas_and_brain\" width=\"1000\">",
+      "id": "d81fc1f4-815a-4e18-9c25-3946d8702e96"
+    }
+  ],
+  "sequence": 2,
+  "category": "Getting Started"
+}