[pull] main from yeonholee50:main

[pull]

See Commits and Changes for more details.

---

Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Updates the README to provide a more comprehensive overview of the AmpyFin trading system, including its features, architecture, installation, usage, and contribution guidelines. The documentation is improved by providing more details on the system's components, setup process, and how to train, test, and deploy models.

Enhancements:

• Enhance the README to provide a comprehensive overview of the AmpyFin trading system.
• Improve documentation by providing more details on the system's components, setup process, and how to train, test, and deploy models.
• Add badges for project status, CI/CD, code quality, package information, community, and metadata.
• Update the installation instructions to include TA-Lib and API key configuration.
• Clarify the usage instructions for training, testing, and deploying models.
• Add a contributing section with guidelines and pre-commit hook setup.
• Include a logging section to describe the log files generated by the system.
• Update the file structure and objectives section to provide a better understanding of the project's organization.
• Add a table summarizing the core components of the architecture.
• Update the prerequisites section to include TA-Lib.
• Update the API setup section to include Weights & Biases.
• Update the setup script section to include instructions for running the script.
• Update the running the system section to include instructions for running the ranking and trading systems.
• Update the training and testing section to include instructions for training and testing the model.
• Update the deploying a model section to include instructions for deploying the model.
• Update the important notes section to include recommendations for live trading.
• Update the logging section to include a description of the log files generated by the system.
• Update the contributing section to include guidelines and pre-commit hook setup.
• Update the license section to include the license type.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request refactors the README to improve clarity and provides a more detailed guide to the AmpyFin trading system. It also modifies the TradeSim module to prevent unintended execution of the test function.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Refactored the README to provide a clearer introduction, feature overview, architecture description, and installation guide for the AmpyFin trading system.	Reorganized the introduction to focus on the mission and goals of AmpyFin. Added a features section detailing data collection, storage, machine learning, and trading strategies. Introduced a section on the dynamic ranking system used to evaluate trading strategies. Included an architecture section outlining core components and their descriptions. Revised the installation guide with prerequisites, setup instructions, and API key configuration. Updated the usage section with instructions for running the system, training, and testing. Added logging and contributing guidelines. Included pre-commit hook instructions.	README.md
Removed the test function call from the main execution block when the mode is not 'push'.	Removed the call to the test function when the execution mode is not set to 'test'. This prevents the test function from running unintentionally during training or model pushing. Ensured that the test function is only called when the mode is explicitly set to 'test'.	TradeSim/main.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.