Intro-to-ML-and-DL

Intro-to-ML-and-DL is a repository for the 2023 Summer Project offered by the Stamatics Society of IIT Kanpur. This repository shall contain the week-wise lessons, resources and assignments for the project.

Installation

Requirements

1. Python 3.6 or higher
2. pip

Setup Git

1. First check if Git is already installed. In the terminal / command prompt type:

git --version

2. If Git is not installed, download Git.
3. Set up your local Git profile in the terminal:

git config --global user.name "your-name"
git config --global user.email "your-email"

4. To check if Git is correctly configured you can type: git config --list

Setup Project

1. Fork the repository.
2. Clone the repository. In your terminal, type:

git clone https://github.com/your-username/Intro-to-ML-and-DL.git

3. Navigate to the repository directory : cd Intro-to-ML-and-DL
4. Set up a remote connection to the original repository git remote add upstream https://github.com/Intro-to-ML-and-DL/Intro-to-ML-and-DL.git
5. Verify that the remote connection : git remote -v. You would see two remote connections: origin (pointing to your forked repository) and upstream (pointing to the original repository).

Syncing your repository with the upstream

1. In your remote repository on Github, click sync fork and then click update to update your repository to the latest commit in the upstream repository.
2. To update the cloned repository in your system, type git pull by opening the terminal inside your project folder.

Uploading Files

Mentees are required to upload their solutions to assignments within the respective deadlines. To upload files, they may either use Github or the following command lines:

1. Stage the files for commit using the git add command. git add filename1 filename2 for specific files and git add . for all files.
2. Verify the files to be modified using : git status command.
3. Use git reset filename to prevent a file from getting staged. Or include the filename in the .gitignore file.
4. Commit the files using the git commit command. git commit -m "Commit message" .
5. Push the files into your main branch/ other branches. git push origin main
6. When you add files for the first time, create a pull request using Github.

Setup Python Virtual Environment

1. Install virtualenv using the following command: pip install virtualenv
2. Navigate to your project directory. cd Intro-to-ML-and-DL . This may differ according to the location in your system.
3. Create a new virtual environment. virtualenv venv . You can replace venv with any name.
4. Activate the virtual environment. On Windows , venv\Scripts\activate.bat. On Linux/macOS , source venv/bin/activate.
5. Run the following command : pip install -r requirements.txt

Happy Coding!!!