search

dsc-tiu / open-source-ml-ai

Open source repository for first time contributors who are ML-AI enthusiasts. Maintainer: Aryan Pareek @diffrxction
MIT License
5 stars 13 forks source link

Add Python code and documentation for Python beginners #1

Open diffrxction opened 1 year ago

diffrxction commented 1 year ago

You are required to add Python code and relevant documentation in sub-folders within the Python folder. Python code and documentation should be in the same sub-folder.

Example:

├── Python
│   ├── Loops in Python (add code and documentation within the new loops in python sub-folder.
│   │   ├── loops.py (Python file showing working of loops)
|   |   ├── loops.md (Markdown file for documentation on how your code works)
│   ├── Functions in Python (code and documentation within one sub-folder)
│   ├── Importing Libraries
│   ├── Python.md (Leave this file intact)

YOU NEED TO SUBMIT BOTH CODE AND MARKDOWN FILE FOR THIS ISSUE

So, the required topics are:

If you are interested, add a comment to this issue and I will allocate the issue to you.

Please see, you will be allotted a small portion of the topics mentioned above just so all interested people have a chance to contribute. Also notice the labels for each issue, that will give you an idea about what kind of work you are expected to do.

Cheers! 😄

Kunal-Garg-12 commented 1 year ago

Assign loops topic to me

diffrxction commented 1 year ago

Assign loops topic to me

Okay @Kunal-Garg-12 you can write code for different loops in Python and add relevant documentation in Python to go along with your code.

Also, please do not forget to maintain the same folder structure as shown above. Create a subfolder for loops and proceed to add loops.py along with the loops.md Markdown documentation file.

daskamalini85 commented 1 year ago

PLEASE ALLOT THE SECTION OF FUNCTIONS IN PYTHON TO ME @diffrxction

ArmaanSeth commented 1 year ago

@diffrxction I will be happy to contribute and have opted for "importing libraries like NumPy, pandas, scikit-learn". Hoping to receive your confirmation as soon as possible!!!

diffrxction commented 1 year ago

PLEASE ALLOT THE SECTION OF FUNCTIONS IN PYTHON TO ME @diffrxction

Okay @daskamalini85 you can proceed with writing about functions in Python, give a few examples of functions, how they work and also provide one documentation file in Markdown (.md) format.

Also, do not forget to follow the folder structure. Create your own subfolder for functions and add functions.py and .md files there.

Javali-M commented 1 year ago

@diffrxction Please assign the NumPy arrays section to me, I'll be happy to work on it.

diffrxction commented 1 year ago

@diffrxction Please assign the NumPy arrays section to me, I'll be happy to work on it.

Sure, @Javali-M. Remember to create a new folder titled NumPy arrays and within this folder include both code and documentation (in .py /.ipynb and .md files). All the best!