File size: 20,104 Bytes
2dc7acf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | {
"cells": [
{
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
"import sys\n",
"sys.path.append('../../../FinNLP')"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {},
"outputs": [],
"source": [
"from finnlp.large_language_models.openai.openai_chat_agent import Openai_Chat_Agent"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {},
"outputs": [],
"source": [
"API_TOKEN = your_openai_api_token # https://platform.openai.com/account/api-keys"
]
},
{
"cell_type": "code",
"execution_count": 4,
"metadata": {},
"outputs": [],
"source": [
"config = {\n",
" \"token\": API_TOKEN,\n",
"}"
]
},
{
"cell_type": "code",
"execution_count": 5,
"metadata": {},
"outputs": [],
"source": [
"agent = Openai_Chat_Agent(config)"
]
},
{
"cell_type": "code",
"execution_count": 7,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Sure, I'd be happy to help you build a factor library in Python for your financial company. Let's get started!\n",
"\n",
"A factor library is a useful tool for quantitative analysis and modeling, which helps in evaluating and creating investment strategies. It provides a set of reusable functions and classes that can be used to calculate various factors or indicators based on financial data.\n",
"\n",
"To build a factor library in Python, we'll start by creating a new Python module to house our library. Let's call it \"factor_library.py\". Open a text editor or an integrated development environment (IDE) and create a new file with that name.\n",
"\n",
"Here's a basic outline of the steps we'll take to build the factor library:\n",
"\n",
"1. Import necessary libraries:\n",
" ```\n",
" import numpy as np\n",
" import pandas as pd\n",
" ```\n",
"\n",
"2. Define functions for different factors:\n",
" - For example, let's create a moving average factor function:\n",
" ```\n",
" def moving_average(df, window):\n",
" return df['close'].rolling(window).mean()\n",
" ```\n",
"\n",
" - You can define various other factors based on your requirements, such as relative strength index (RSI), exponential moving average (EMA), Bollinger Bands, etc.\n",
"\n",
"3. Create a class to encapsulate related factors:\n",
" - The class can be used to package multiple related factors together and provide a consistent interface.\n",
" - Here's an example:\n",
" ```\n",
" class TechnicalIndicators:\n",
" def __init__(self, df):\n",
" self.df = df\n",
"\n",
" def moving_average(self, window):\n",
" return self.df['close'].rolling(window).mean()\n",
"\n",
" def rsi(self, window):\n",
" # Implement RSI calculation logic here\n",
" pass\n",
"\n",
" # Other factor functions can be added similarly\n",
" ```\n",
"\n",
"4. Test the library:\n",
" - After implementing each factor, write some test code to ensure that the functions are working as expected.\n",
" - For example:\n",
" ```\n",
" df = pd.read_csv('financial_data.csv')\n",
" ti = TechnicalIndicators(df)\n",
" ma_50 = ti.moving_average(50)\n",
" print(ma_50)\n",
" ```\n",
"\n",
"5. Document the library:\n",
" - To make it easier for others (including yourself) to understand and use the library, provide clear documentation for each function, class, and their parameters.\n",
" - You can use docstrings and comments to explain the purpose, inputs, and outputs of each function.\n",
"\n",
"Once you've completed these steps, you'll have a basic factor library in Python that you can expand upon and customize according to your specific needs. Remember to adhere to programming best practices, such as modular design, code reusability, and readability.\n",
"\n",
"Keep in mind that the example provided here is just a starting point, and the actual implementation of the factors will depend on your requirements and the financial data you're working with.\n",
"\n",
"I hope this helps you get started with building your factor library in Python. Let me know if you have any further questions!\n"
]
}
],
"source": [
"Init_Prompt = \"You are now a senior software development engineer in top financial company. You will help me to build a factor library in Python today.\"\n",
"answer = agent.get_single_response(Init_Prompt)\n",
"print(answer)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Sure, I'd be happy to help you build a factor library in Python for your financial company. Let's get started!\n",
"\n",
"A factor library is a useful tool for quantitative analysis and modeling, which helps in evaluating and creating investment strategies. It provides a set of reusable functions and classes that can be used to calculate various factors or indicators based on financial data.\n",
"\n",
"To build a factor library in Python, we'll start by creating a new Python module to house our library. Let's call it \"factor_library.py\". Open a text editor or an integrated development environment (IDE) and create a new file with that name.\n",
"\n",
"Here's a basic outline of the steps we'll take to build the factor library:\n",
"\n",
"1. Import necessary libraries:\n",
" ```\n",
" import numpy as np\n",
" import pandas as pd\n",
" ```\n",
"\n",
"2. Define functions for different factors:\n",
" - For example, let's create a moving average factor function:\n",
" ```\n",
" def moving_average(df, window):\n",
" return df['close'].rolling(window).mean()\n",
" ```\n",
"\n",
" - You can define various other factors based on your requirements, such as relative strength index (RSI), exponential moving average (EMA), Bollinger Bands, etc.\n",
"\n",
"3. Create a class to encapsulate related factors:\n",
" - The class can be used to package multiple related factors together and provide a consistent interface.\n",
" - Here's an example:\n",
" ```\n",
" class TechnicalIndicators:\n",
" def __init__(self, df):\n",
" self.df = df\n",
"\n",
" def moving_average(self, window):\n",
" return self.df['close'].rolling(window).mean()\n",
"\n",
" def rsi(self, window):\n",
" # Implement RSI calculation logic here\n",
" pass\n",
"\n",
" # Other factor functions can be added similarly\n",
" ```\n",
"\n",
"4. Test the library:\n",
" - After implementing each factor, write some test code to ensure that the functions are working as expected.\n",
" - For example:\n",
" ```\n",
" df = pd.read_csv('financial_data.csv')\n",
" ti = TechnicalIndicators(df)\n",
" ma_50 = ti.moving_average(50)\n",
" print(ma_50)\n",
" ```\n",
"\n",
"5. Document the library:\n",
" - To make it easier for others (including yourself) to understand and use the library, provide clear documentation for each function, class, and their parameters.\n",
" - You can use docstrings and comments to explain the purpose, inputs, and outputs of each function.\n",
"\n",
"Once you've completed these steps, you'll have a basic factor library in Python that you can expand upon and customize according to your specific needs. Remember to adhere to programming best practices, such as modular design, code reusability, and readability.\n",
"\n",
"Keep in mind that the example provided here is just a starting point, and the actual implementation of the factors will depend on your requirements and the financial data you're working with.\n",
"\n",
"I hope this helps you get started with building your factor library in Python. Let me know if you have any further questions!"
]
},
{
"cell_type": "code",
"execution_count": 8,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Certainly! When designing the base class for all factors, it's important to consider the common functionality and attributes that factors will share. Here's an example of how you can design the base class for factors in Python:\n",
"\n",
"```python\n",
"import pandas as pd\n",
"\n",
"class Factor:\n",
" def __init__(self, df):\n",
" self.df = df\n",
"\n",
" def calculate(self):\n",
" \"\"\"\n",
" This method should be implemented in each derived factor class.\n",
" It should contain the specific logic to calculate the factor value.\n",
" \"\"\"\n",
" raise NotImplementedError(\"Subclasses must implement calculate method.\")\n",
"```\n",
"\n",
"In this base class, we define an `__init__` method that takes a data frame `df` as input. This allows us to initialize the base factor class with the necessary financial data. You can enhance this class by including other common attributes that all factors may need.\n",
"\n",
"We also define a `calculate` method, which is marked as `NotImplementedError`. This method needs to be overridden in each derived factor class with the specific logic to calculate the factor value.\n",
"\n",
"Now, any specific factor class you create should inherit from this base `Factor` class and implement its own `calculate` method:\n",
"\n",
"```python\n",
"class MovingAverageFactor(Factor):\n",
" def __init__(self, df, window):\n",
" super().__init__(df)\n",
" self.window = window\n",
"\n",
" def calculate(self):\n",
" return self.df['close'].rolling(self.window).mean()\n",
"```\n",
"\n",
"In this example, we create a `MovingAverageFactor` class that inherits from the base `Factor` class. It takes an additional `window` parameter specific to the moving average calculation. The `calculate` method in this class implements the logic to calculate the moving average factor value using the `rolling` method from pandas.\n",
"\n",
"By designing a base class for all factors, you establish a consistent structure that can be used to create and organize various factor classes. This approach allows for easy expansion and maintenance of your factor library.\n",
"\n",
"Remember, this is just a basic example, and you can add more functionality and attributes to the base class as per your requirements.\n"
]
}
],
"source": [
"Prompt_1 = \"First, please help me design the base class of all factors\"\n",
"answer = agent.get_single_response(Prompt_1)\n",
"print(answer)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Certainly! When designing the base class for all factors, it's important to consider the common functionality and attributes that factors will share. Here's an example of how you can design the base class for factors in Python:\n",
"\n",
"```python\n",
"import pandas as pd\n",
"\n",
"class Factor:\n",
" def __init__(self, df):\n",
" self.df = df\n",
"\n",
" def calculate(self):\n",
" \"\"\"\n",
" This method should be implemented in each derived factor class.\n",
" It should contain the specific logic to calculate the factor value.\n",
" \"\"\"\n",
" raise NotImplementedError(\"Subclasses must implement calculate method.\")\n",
"```\n",
"\n",
"In this base class, we define an `__init__` method that takes a data frame `df` as input. This allows us to initialize the base factor class with the necessary financial data. You can enhance this class by including other common attributes that all factors may need.\n",
"\n",
"We also define a `calculate` method, which is marked as `NotImplementedError`. This method needs to be overridden in each derived factor class with the specific logic to calculate the factor value.\n",
"\n",
"Now, any specific factor class you create should inherit from this base `Factor` class and implement its own `calculate` method:\n",
"\n",
"```python\n",
"class MovingAverageFactor(Factor):\n",
" def __init__(self, df, window):\n",
" super().__init__(df)\n",
" self.window = window\n",
"\n",
" def calculate(self):\n",
" return self.df['close'].rolling(self.window).mean()\n",
"```\n",
"\n",
"In this example, we create a `MovingAverageFactor` class that inherits from the base `Factor` class. It takes an additional `window` parameter specific to the moving average calculation. The `calculate` method in this class implements the logic to calculate the moving average factor value using the `rolling` method from pandas.\n",
"\n",
"By designing a base class for all factors, you establish a consistent structure that can be used to create and organize various factor classes. This approach allows for easy expansion and maintenance of your factor library.\n",
"\n",
"Remember, this is just a basic example, and you can add more functionality and attributes to the base class as per your requirements."
]
},
{
"cell_type": "code",
"execution_count": 9,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Certainly! Here are five examples of fundamental factors that you can design based on the base `Factor` class:\n",
"\n",
"1. Price-to-Earnings Ratio (P/E Ratio):\n",
"```python\n",
"class PERatioFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['close'] / self.df['earnings_per_share']\n",
"```\n",
"In this example, the `calculate` method divides the closing price of each data point by the corresponding earnings per share to calculate the P/E ratio factor.\n",
"\n",
"2. Price-to-Book Ratio (P/B Ratio):\n",
"```python\n",
"class PBRatioFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['close'] / self.df['book_value_per_share']\n",
"```\n",
"The `calculate` method divides the closing price by the book value per share to calculate the P/B ratio factor.\n",
"\n",
"3. Dividend Yield:\n",
"```python\n",
"class DividendYieldFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['dividends'] / self.df['close']\n",
"```\n",
"The `calculate` method divides the dividends by the closing price to calculate the dividend yield factor.\n",
"\n",
"4. Debt-to-Equity Ratio:\n",
"```python\n",
"class DebtToEquityRatioFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['total_debt'] / self.df['total_equity']\n",
"```\n",
"The `calculate` method divides the total debt by the total equity to calculate the debt-to-equity ratio factor.\n",
"\n",
"5. Return on Equity (ROE):\n",
"```python\n",
"class ROEFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['net_income'] / self.df['total_equity']\n",
"```\n",
"The `calculate` method divides the net income by the total equity to calculate the return on equity factor.\n",
"\n",
"These are just a few examples of fundamental factors that you can calculate based on the provided base `Factor` class. Remember to customize the calculations based on the specific financial data columns available in your data frame (`df`). You can expand upon these examples and create additional factor classes based on your requirements.\n"
]
}
],
"source": [
"Prompt_2 = \"Second, please help me design 5 fundamental factors based on the base class\"\n",
"answer = agent.get_single_response(Prompt_2)\n",
"print(answer)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Certainly! Here are five examples of fundamental factors that you can design based on the base `Factor` class:\n",
"\n",
"1. Price-to-Earnings Ratio (P/E Ratio):\n",
"```python\n",
"class PERatioFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['close'] / self.df['earnings_per_share']\n",
"```\n",
"In this example, the `calculate` method divides the closing price of each data point by the corresponding earnings per share to calculate the P/E ratio factor.\n",
"\n",
"2. Price-to-Book Ratio (P/B Ratio):\n",
"```python\n",
"class PBRatioFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['close'] / self.df['book_value_per_share']\n",
"```\n",
"The `calculate` method divides the closing price by the book value per share to calculate the P/B ratio factor.\n",
"\n",
"3. Dividend Yield:\n",
"```python\n",
"class DividendYieldFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['dividends'] / self.df['close']\n",
"```\n",
"The `calculate` method divides the dividends by the closing price to calculate the dividend yield factor.\n",
"\n",
"4. Debt-to-Equity Ratio:\n",
"```python\n",
"class DebtToEquityRatioFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['total_debt'] / self.df['total_equity']\n",
"```\n",
"The `calculate` method divides the total debt by the total equity to calculate the debt-to-equity ratio factor.\n",
"\n",
"5. Return on Equity (ROE):\n",
"```python\n",
"class ROEFactor(Factor):\n",
" def calculate(self):\n",
" return self.df['net_income'] / self.df['total_equity']\n",
"```\n",
"The `calculate` method divides the net income by the total equity to calculate the return on equity factor.\n",
"\n",
"These are just a few examples of fundamental factors that you can calculate based on the provided base `Factor` class. Remember to customize the calculations based on the specific financial data columns available in your data frame (`df`). You can expand upon these examples and create additional factor classes based on your requirements."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
"kernelspec": {
"display_name": "langchain",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
},
"orig_nbformat": 4
},
"nbformat": 4,
"nbformat_minor": 2
}
|