akshitagupta15june / akshitagupta15june/Face-X

Documentation Improvement to Readme.md file to include and update tutorial on how to use Face-X library

Open
#1,808 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
853
Forks
596
PR merge metrics
No merged PRs in 30d

Description

The Readme.md file of the repository lacks a tutorial on how to use the Face-X features. There is a tutorial present in the README.md file of the facex-library, but may be difficult for newcomers to identify. Additionally there are some dependencies that are required to use the features but are not included in the tutorial.

I would like to update the Readme.md to include documentation on a tutorial example on how to use the cartoonify feature in Face-X. I would also update the tutorial to include installing modules required to run the example that were not mentioned in the tutorial such as imutils and matplotlib.

My reasoning for updating and including the tutorial is to create an open and easy environment for new users and developers.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.