debadityapal / learn-hub

An interactive Onboarding environment for new users of Hub

Note: This is an Unofficial Community Project for GSoC 2021

What is LearnHub?

LearnHub is an auxilliary tool which provides an interactive onboarding experience for the new users of Hub.

Reading the Documentation can be time Consuming and Boring

Hence, we have created a library that provides interactive tutorial courses on how to get started with using Hub, right at the comfort of your local terminal.

What is Hub?

The fastest way to access and manage datasets for PyTorch and TensorFlow

Hub provides fast access to the state-of-the-art datasets for Deep Learning, enabling data scientists to manage them, build scalable data pipelines and connect to Pytorch and Tensorflow.

Getting Started

Installing

Follow these steps to install and start using LearnHub.

git clone https://github.com/DebadityaPal/learn-hub
cd learn-hub
pip install -e .

Upgrade

If you want to upgrade your current installation of LearnHub, follow these steps.

cd learn-hub
git pull origin main

Running a Course

Note: You need to use Python 3.x

If you want to run a course you simply need to run the following command on the console.

python3 learn run courses/<course_name>

for example

python3 learn run "courses/Getting started with Hub"

A list of all the available courses can be acquired by running

python3 learn list

Linux users can remove the python part from both the commands.

GSoC Checklist

• Make a Basic YAML parser to read course files.
• Make a general course engine to provide content on the terminal.
• Make General Snippet class which will be extended later.
• Make Text Snippet Class
• Make MCQ Snippet Class
• Make Code Snippet Class
• Add Automated Documentation Pipeline
• Add Courses in the library after incorporating team feedback.
• Stretch: Add colors to make courses visually appealing.