Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make a documentation page for DeepLab #2

Open
SasikaA073 opened this issue Apr 12, 2024 · 0 comments
Open

Make a documentation page for DeepLab #2

SasikaA073 opened this issue Apr 12, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@SasikaA073
Copy link
Contributor

SasikaA073 commented Apr 12, 2024

These things should be included.

  1. Paper Link
  2. Paper Summary
  3. Model Architecture Diagram
  4. Results on a specific dataset (please mention the dataset that you used), add images
  5. Results on the box dataset we made (add images)

Now you should run the code we made for each model (the model that you were assigned by sir) in Google Colab or local machine.

There should be another section with a step-by-step guide on how to set up the environment to work with.
Please add every detail including the pitfalls.

You can refer to Hugo Documentation and Hugo theme documentation.

Warning

Please don't use ChatGPT to generate the documentation. Assistance from ChatGPT or any other thing is fine. We don't want our documentation to sound like robots. You may use your own words.

How to do the changes

  • Make a new branch with your name for example sasika
  • Then do the necessary changes and make content.
  • Push the changes to a branch with your name. Remote branch may also be your name.
  • Make a pull-request to the dev branch.

Warning

When you use images rename them with some meaningful name like deeplab_architecture.png not like lkjlajlfja2012-23-43.png

@SasikaA073 SasikaA073 added the documentation Improvements or additions to documentation label Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants