Setup ML-X in Your Environment !

Follow the steps below to setup ML-X in your local system.

Clone Repo or Download Files

Before begin, your first step is to clone the Github Repository OpenCodeEra/ML-X or alternatively, you have the option to download the files.

If you don't know how to clone or where to download the code then watch this video.

Or you can run this code in your PC/Laptop terminal

git clone https://github.com/OpenCodeEra/ML-X.git

Great 👏, you have your project ready in your system. Let's explore contribution.

Here, We welcome your ideas and innovation. You can contribute by either updating pre-existing notebooks/models or starting a new model.

We use the Google Colab environment for model development, and also suggest it to you. However, you have the freedom to use others as well.

You can select from different ideas and improvements for existing notebooks. For example, you can use a different algorithm or dataset with the same model.
Your contributions are flexible, so you can enhance existing content in various ways.

You also can add your basic or advanced ml models and notebooks, to make ML-X one-stop hub for everyone.

Before you start working, kindly add your model idea in the Issues section, and we'll be happy to assign it to you. We've also provided an issue template format to make it easy for you to share your model ideas.
When writing a notebook for your model, it's important to include notes in every section. You can refer to HandWritten Digit Recognition/notebook.ipnyb for reference.
To commit your notebook to the repository, follow these steps :-
- After you've finished your coding, go to the top left section in Colab, click on File, and select Save a copy in Github.
- A window will appear. Scroll down and search for your forked ML-X repo in Repository ie. <Your-Github-Username>/ML-X, then add your file path in this format: <Model Folder Name>/notebook.ipnyb.
- also add an appropriate commit message as per your choice. Don't uncheck include a link to Colaboratory.
- Well done.. Your changes will now appear in your forked repo!

Now, at this point, you've completed most of the necessary steps. Go ahead and create a PR!
And guess what? We've provided a PR Template to make the process even easier for you.

We'll carefully look over your PR and accordingly accept it for your Hacktoberfest Journey. 🚀

Congratulations on your contribution to ML-X! 🎉