{"id":3293,"date":"2022-08-22T13:13:31","date_gmt":"2022-08-22T13:13:31","guid":{"rendered":"https:\/\/lucylabs.gatech.edu\/ml4t\/?page_id=3293"},"modified":"2022-08-22T13:14:48","modified_gmt":"2022-08-22T13:14:48","slug":"project-guidelines-2","status":"publish","type":"page","link":"https:\/\/lucylabs.gatech.edu\/ml4t\/fall2022\/project-guidelines-2\/","title":{"rendered":"Project Guidelines"},"content":{"rendered":"

[et_pb_section fb_built=”1″ _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_row _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_column type=”4_4″ _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_text _builder_version=”4.18.0″ _module_preset=”4a599f9e-867c-4f9e-a4a4-3dea6e9979ab” header_font=”|700||on|||||” header_text_align=”center” hover_enabled=”0″ global_colors_info=”{}” theme_builder_area=”post_content” sticky_enabled=”0″]<\/p>\n

CS7646 \u2013 Machine Learning for Trading \u2013 Fall 2022<\/span><\/b>\u00a0<\/span><\/h1>\n

Course Development Recommendations, Guidelines, and Rules<\/span><\/b>\u00a0<\/span><\/h1>\n

<\/span><\/p>\n

The following development requirements and guidelines apply to all projects unless otherwise noted in the specific project requirements.<\/span><\/span>\u00a0<\/span><\/span><\/p>\n

[\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_column type=”4_4″ _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_text _builder_version=”4.16″ _module_preset=”4a599f9e-867c-4f9e-a4a4-3dea6e9979ab” global_colors_info=”{}” theme_builder_area=”post_content”]<\/p>\n

Always <\/span>Allowed<\/span><\/span>\u00a0<\/span><\/h2>\n
    \n
  • You can use any library that is on the Local Environment Setup page.\u00a0<\/span>\u00a0<\/span><\/li>\n
  • You may use any standard python library in your implementations (<\/span>except for the Python OS<\/span> library, which is always prohibited).<\/span>\u00a0<\/span><\/li>\n
  • You may use code provided by the instructional staff or explicitly allowed by the instructional staff.<\/span>\u00a0<\/span><\/li>\n
  • You may use code written in prior terms of CS7646 and other Georgia Tech OMS courses, provided: 1) you are the sole author, 2) the code fully meets the assignment requirements, and 3) the code is properly cited and referenced.<\/span>\u00a0<\/span><\/li>\n<\/ul>\n

    [\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_column type=”4_4″ _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_text _builder_version=”4.16″ _module_preset=”4a599f9e-867c-4f9e-a4a4-3dea6e9979ab” global_colors_info=”{}” theme_builder_area=”post_content”]<\/p>\n

    Allowed with some exceptions<\/span> (<\/span>exceptions<\/span> stated in project <\/span>wiki<\/span>)<\/span><\/span>\u00a0<\/span><\/h2>\n
      \n
    • F<\/span><\/span>iles may be read using <\/span>only 1) the <\/span>functions in the util.<\/span>py<\/span> file or <\/span>2) <\/span>other methods provided in \u201ctest\u201d files that accompany specific projects<\/span>, unless prohibited in the project wiki<\/span>. <\/span>As an example of an exception, <\/span>Project 5 also allows the use of <\/span>pandas.<\/span>read<\/span>_csv<\/span>() to read the orders files<\/span> alone<\/span>.<\/span><\/span>\u00a0<\/span><\/li>\n<\/ul>\n

      [\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_column type=”4_4″ _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_text _builder_version=”4.16″ _module_preset=”4a599f9e-867c-4f9e-a4a4-3dea6e9979ab” global_colors_info=”{}” theme_builder_area=”post_content”]<\/p>\n

      Always <\/span>Prohibited<\/span><\/span>\u00a0<\/span><\/h2>\n
        \n
      • B<\/span>y default, code must not cause any information to be printed on a window\/screen\/console\/terminal in the implementation submitted for grading.<\/span>\u00a0<\/span>\u00a0<\/span><\/li>\n
      • Code must never cause charts to appear on a window\/screen\/console\/terminal in the implementations submitted for grading (e.g., Do not use plt.show() or any function that calls plt.show()). <\/span>Be aware that some functions in util.py may be useful in debugging because they will display charts on a local machine but should not be used in the implementation submitted for grading.<\/span>\u00a0<\/span><\/li>\n
      • Code must not use global variables. (E.g., All code should exist as functions or classes.)<\/span>\u00a0<\/span><\/li>\n
      • Code must never use the Python OS library, which is a<\/span>lways prohibited.<\/span>\u00a0<\/span><\/li>\n
      • Code must never use any library that is\u00a0NOT specified in the Allowed section (above) or in the Project instructions.<\/span>\u00a0<\/span><\/li>\n
      • You may NOT move, edit, or copy environment files. For example, do not edit or copy util.py.<\/span>\u00a0<\/span>\u00a0<\/span><\/li>\n
      • You may NOT move files or folders to different locations to get your code to work.\u00a0<\/span>\u00a0<\/span><\/li>\n
      • Y<\/span>ou may never use code you did not write yourself<\/span> (except for properly cited code that is provided by the instructional staff).<\/span>\u00a0<\/span><\/li>\n
      • You must not edit (i.e., add, change, or delete) anything (including spaces) above the line that reads: \u201c\u2014do not edit anything above this line\u2014\u201c.<\/span>\u00a0<\/span><\/li>\n
      • Code must not create any new directories or temporary working files.<\/span>\u00a0<\/span><\/li>\n
      • An implementation must NOT use an absolute Import statement.<\/span> An absolute import statement is one that includes a folder name in the statement. For example, if a specific directory (e.g., \u201cassess_Learners\u201d) is used in the import or from statement, we consider it an absolute import. For, example, \u201cfrom assess_learners.DTLearner import DTLearner\u201d.<\/span>\u00a0<\/span><\/li>\n
      • An implementation cannot leverage an existing Machine Learning package or library.<\/span>\u00a0<\/span><\/li>\n
      • Any Classes (other than Random) that create their own instance variables for later use (e.g., learners like kdtree).\u00a0<\/span>\u00a0<\/span><\/li>\n
      • Code that includes any data reading routines. The provided testlearner.py code reads data for you.<\/span>\u00a0<\/span><\/li>\n<\/ul>\n
          <\/ul>\n
            <\/ul>\n
              <\/ul>\n

              [\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_column type=”4_4″ _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_text _builder_version=”4.16″ _module_preset=”4a599f9e-867c-4f9e-a4a4-3dea6e9979ab” global_colors_info=”{}” theme_builder_area=”post_content”]<\/p>\n

              Prohibited with some exceptions<\/span> (exceptions stated in the project wiki)<\/span><\/span>\u00a0<\/span><\/h2>\n
                \n
              • Random seeds may not be set in a project<\/span>\u00a0unless specifically allowed the project wiki. When allowed, a seed must: 1) be set only once per execution cycle, 2) be contained only in the designated file as stated in the project instructions, and 3) use your numeric GT ID as the seed value.<\/span>\u00a0<\/span><\/li>\n
              • You may not share Tables, Charts, or Statistics<\/span>\u00a0unless specifically allowed in dedicated threads in the class online forum.<\/span>\u00a0<\/span><\/li>\n<\/ul>\n

                [\/et_pb_text][\/et_pb_column][\/et_pb_row][et_pb_row _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_column type=”4_4″ _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”][et_pb_text _builder_version=”4.16″ _module_preset=”4a599f9e-867c-4f9e-a4a4-3dea6e9979ab” global_colors_info=”{}” theme_builder_area=”post_content”]<\/p>\n

                Recommendations<\/span><\/span>\u00a0<\/span><\/h2>\n

                While the use of print statements is useful when debugging, the code cannot print when in Gradescope. One way to ensure that your code prints locally, but not in Gradescope is via the use of a command-line\u00a0argument.\u00a0<\/span>\u00a0<\/span><\/p>\n

                The following code segment shows how implementation will print to a screen when \u2013debug appears as the last statement in a command line. Within an IDE, this statement will need to be explicitly added as a parameter.\u00a0 Assume a file named testFile.py contains the following:<\/span>\u00a0<\/span><\/p>\n

                [\/et_pb_text][et_pb_code _builder_version=”4.16″ _module_preset=”default” global_colors_info=”{}” theme_builder_area=”post_content”]