Skip to content

Latest commit

 

History

History
192 lines (159 loc) · 8.42 KB

README.md

File metadata and controls

192 lines (159 loc) · 8.42 KB

Hey <𝚌𝚘𝚍𝚎𝚛𝚜/>! 👋

Typing SVG


⚡ About AI Code 🌟

AI Code is an open-source initiative designed to make learning Artificial Intelligence (AI) more accessible, structured, and hands-on. Whether you're a beginner or an experienced developer, AI-Code provides scratch implementations of various AI algorithms alongside real-world project guides, helping you bridge the gap between theory and practice.

⚡ Core Features 🔑

  • Scratch-level implementations of AI algorithms 🧠
  • Guides, datasets, research papers, and step-by-step tutorials 📘
  • Clear directories with focused README files 📂
  • Fast learning with minimal complexity 🚀

⚡ Setup the Project 🍱

  1. Go through the Contributing Guidelines to fork and clone the project.
  2. After forking and cloning the project in your local system:
    • Create a virtual environment:
      python -m venv myenv
    • Activate the virtual environment:
      • On Windows:
        myenv\Scripts\activate
      • On macOS/Linux:
        source myenv/bin/activate
    • Install the required Python package:
      pip install mkdocs-material
  3. After installing the package, run the following command to start the development server:
    mkdocs serve
  4. Open the local server URL (usually http://127.0.0.1:8000) in your browser. You are now ready to work on the project.

⚡ Important Points to remember while submitting your work 📍

We want your work to be readable by others; therefore, we encourage you to note the following:

  1. File names should be in kebab-case letters (e.g., music-genre-classification-model, insurance-cross-sell-prediction).
  2. Follow the PROJECT README TEMPLATE and ALGORITHM README TEMPLATE for refrence.
  3. Do not upload images or video files directly. Use a GitHub raw URL in the documentation.
  4. Upload your notebook to Kaggle, make it public, and share the Kaggle embed link only. Other links are not accepted.
  5. Limit commits to 3-4 unless given permission by project Admins or Mentors.
  6. Keep commit messages clear and relevant; avoid unnecessary details.

⚡ Pull Requests Review Criteria 🧲

  1. It must required to follow mentioned do/don't guidelines.
  2. Please fill the PR Template properly while making a Pull Request.
  3. Do not commit directly to the main branch, or your PR will be instantly rejected.
  4. Ensure all work is original and not copied from other sources.
  5. Add comments to your code wherever necessary for clarity.
  6. Include a working video and show integration with AI-Code MkDocs Documentation website as part of your PR.
  7. For frontend updates, share screenshots and work samples before submitting a PR.

❄️ Open Source Programs

SSOC

2024

VSOC

2024

KWOC

2024

IWOC

2025

SWOC

2025

DWOC

2025

✨ Our Valuable Contributors

Line

Tip from us 😇

It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪

Show some  ❤️  by  🌟  this repository!