cnhkmcp 2.1.2__py3-none-any.whl → 2.1.4__py3-none-any.whl

cnhkmcp/untracked/AI/321/206/320/261/320/234/321/211/320/255/320/262/321/206/320/237/320/242/321/204/342/225/227/342/225/242/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"
+}

cnhkmcp/untracked/AI/321/206/320/261/320/234/321/211/320/255/320/262/321/206/320/237/320/242/321/204/342/225/227/342/225/242/knowledge/001_Introduction_to_BRAIN_Expression_Language_documentation.json

@@ -0,0 +1,107 @@
+{
+  "id": "introduction-brain-expression-language",
+  "title": "Introduction to BRAIN Expression Language",
+  "lastModified": "2025-03-12T05:14:01.490538-04:00",
+  "content": [
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "What is Fast Expression?"
+      },
+      "id": "553a60d0-37e0-4625-8f7d-c5ef86ed30a8"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>“Fast expression” is a proprietary programming language used by WorldQuant BRAIN that is designed to make it easier to write and test financial models. The language can be thought as a form of pseudo code, which uses natural language and simple programming constructs to convey the logic of the algorithm.</p><p>The goal of using “Fast expression” on BRAIN is to provide a clear and concise way to express complex ideas and algorithms that can be easily understood by other developers and researchers. By abstracting away the details of the underlying implementation, it can allow BRAIN users to focus on the high-level logic of their algorithms, rather than getting bogged down in the implementation details.</p>",
+      "id": "2a54cace-a5e3-4d30-9fe3-e2f976b1e03c"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Characteristics of Fast Expression"
+      },
+      "id": "469a78b4-403e-4204-bbb6-0fabc21f372b"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p>Just like how an English sentence consists of a subject, verb and object; Fast expression can include data fields, operators and numerical values.</p><p></p>",
+      "id": "74954f01-9581-4355-a926-dfa9347905c8"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "2",
+        "content": "Data fields"
+      },
+      "id": "47e55432-bec2-4b7c-b636-6d3f3017d860"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p><a href=\"$reference/datasets\">Data fields</a> refer to a named collection of data, for example 'open price' or 'close price'.</p><p></p>",
+      "id": "d4f5ff04-cdc7-489d-998c-99755cb87179"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "Datasets and data fields",
+        "width": 1512,
+        "height": 790,
+        "fileSize": 74162,
+        "url": "https://api.worldquantbrain.com/content/images/IaAoDv9Y8tslj4pCv6M9pFU6TWM=/177/original/dataset_1.png"
+      },
+      "id": "451c79a7-30d1-4598-8885-cedb44e6ae3e"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "2",
+        "content": "Operators"
+      },
+      "id": "6b4a64b9-5252-4fae-9307-3e44171597b4"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><p><a href=\"$reference/operators\">Operators</a> refer to a set of mathematical techniques required to implement your Alpha ideas.</p><p></p>",
+      "id": "d6851e78-9142-4ffa-a645-d22097581b37"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "Operators",
+        "width": 1074,
+        "height": 373,
+        "fileSize": 100643,
+        "url": "https://api.worldquantbrain.com/content/images/0kiNQvb4d7dnltnIbeuU-K7zL_4=/178/original/Operators_1.png"
+      },
+      "id": "8e9f0794-4eac-4953-809f-a677c547c0ef"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Further Knowledge of Fast Expression"
+      },
+      "id": "504523a2-9d2c-4052-ab43-112da93fdb80"
+    },
+    {
+      "type": "IMAGE",
+      "value": {
+        "title": "Punctuation",
+        "width": 1072,
+        "height": 408,
+        "fileSize": 143837,
+        "url": "https://api.worldquantbrain.com/content/images/Qvkynvp_PtZnsLtCWadN9FkSEZ4=/179/original/Punctuation.png"
+      },
+      "id": "bf6b9174-45be-47f8-9374-91af5fa789bb"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><ul><li><b><i>/*</i></b> helps to create block comments that span multiple lines of text, while<b><i> */</i></b> denotes the end of the comment. Comments consist of explanatory text to help understand what the code does. [1]</li><li><b><i>;</i></b> (semicolon) acts as a semicolon in a sentence, separating the end of one sentence from the beginning of another sentence. For the last line of the code (line 13) ; is not needed. [2]</li><li>The last sentence of the entire expression is the Alpha expression that the BRAIN simulator use to calculate the positions to take in each stock. [3]</li></ul><p>Lastly, Fast expression does not have classes, objects, pointers, or functions.</p><p>In summary, Fast expression provides a clear and concise way for users to express complex ideas and algorithms. Don’t worry if you’re not familiar with Fast expression yet. With a bit of practice, we believe you’ll pick it up in no time!</p>",
+      "id": "2eda68a5-3492-4f19-bd59-34f5077d7b7f"
+    }
+  ],
+  "sequence": 3,
+  "category": "Getting Started"
+}

cnhkmcp/untracked/AI/321/206/320/261/320/234/321/211/320/255/320/262/321/206/320/237/320/242/321/204/342/225/227/342/225/242/knowledge/001_WorldQuant_Challenge_documentation.json

@@ -0,0 +1,56 @@
+{
+  "id": "challenge-help",
+  "title": "WorldQuant Challenge",
+  "lastModified": "2025-03-12T05:07:12.194953-04:00",
+  "content": [
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Overview"
+      },
+      "id": "cdc32a30-77ce-4eae-94f0-cf38bc1c3a2a"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>The WorldQuant Challenge is a perpetual, online, solo competition. Users can submit <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\">Alphas</a> to improve their scores and ranking.</p><p>Individuals who score 10,000 points may be eligible to receive an invitation for the research consultant opportunity, subject to other <a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4418509454999\">criteria</a>(e.g. if they are residents in countries where the BRAIN consultant program is offered). Users who make it to Gold and Silver levels will have access to special training sessions and videos through the Events page.</p><p>New users are automatically enrolled into the challenge. The <a href=\"https://platform.worldquantbrain.com/competition/challenge\">Leaderboard</a> ranks all eligible users and can be filtered by country, university and/or city.</p>",
+      "id": "80f9d638-0d83-4a18-86b3-0bfec80051ea"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "1",
+        "content": "Scoring criteria"
+      },
+      "id": "8e4bd633-5f75-402b-8d56-398230494545"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "2",
+        "content": "Summary"
+      },
+      "id": "5c522633-15e3-4978-ba47-80fe5a3e2fd3"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p></p><ol><li>Your score is based on the quantity and quality (performance in the 5 year in-sample period) of Alphas that you submit on the platform</li><li>Your score also depends on quantity and quality of Alphas submitted by other users that day</li><li>Score is calculated per day (EST timezone), and not per Alpha</li><li>Highest daily score you can achieve is 2,000. Typically, this involves submitting 1 to 2 Alphas a day</li><li>There are no negative points. Your score cannot decrease</li><li>Scores refresh once every day at 3 AM EST</li><li>Participants with the same score will have the same rank</li><li>You can reach three levels in WorldQuant Challenge:<ol><li>Bronze (score &gt; 1,000)</li><li>Silver (score &gt; 5,000)</li><li>Gold (score &gt; 10,000)</li></ol></li></ol>",
+      "id": "0aa80ea1-a32c-4aa3-9fe0-b63c4c06e1b8"
+    },
+    {
+      "type": "HEADING",
+      "value": {
+        "level": "2",
+        "content": "Details"
+      },
+      "id": "305c4488-632e-4d7e-ac12-36dd734f858a"
+    },
+    {
+      "type": "TEXT",
+      "value": "<p>Each day, all Alphas submitted by a user accumulated and two factors are calculated:</p><p><b>Quantity Factor:</b> Larger the number of Alphas you submit during a day. Larger the factor, higher your score</p><p><b>Quality factor:</b> Quality factor is calculated as an average of the quality factor of all Alphas submitted during the day. Larger the factor, higher your score. It depends on the following settings and results in the in-sample period:</p><ul><li><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> (smaller universes get more score)</li><li><a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=details%C2%A0*).-,Self%20correlation,-Maximum\">SelfCorrelation</a> (the lesser the better)</li><li><a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=ratios.-,Fitness,-Fitness\">Fitness</a> (the higher the better)</li><li><a href=\"https://support.worldquantbrain.com/hc/en-us/articles/4902349883927-Click-here-for-a-list-of-terms-and-their-definitions#:~:text=days-,Delay,-An\">Delay</a> (D1 Alphas contribute more to the score than D0 Alphas)</li></ul><p>Both factors are then normalized across all the users who submitted at least one Alpha on that particular day. Your final daily score is then function of normalized Quantity and Quality Factors. The daily score is capped at 2,000 points.</p>",
+      "id": "05b04df4-3f7b-4152-97ac-f1aef9384697"
+    }
+  ],
+  "sequence": 31,
+  "category": "Getting Started"
+}