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

Docs restructuring, part 1 (reland) #221

Merged
merged 4 commits into from
Apr 23, 2023
Merged

Conversation

theabhirath
Copy link
Member

@theabhirath theabhirath commented Apr 22, 2023

Rebasing #201 was a bit of pain, so I just decided to make a new PR instead. Closes #201 (supersedes).


This is the PR for landing the first half of the docs restructuring, which will include, amongst other things

  1. more docstrings
  2. a proper export of the Layers API from Metalhead (or at least the layers that are stable), with documentation added for them
  3. Some tutorials to start working with Metalhead (including pre-trained models and using them as feature extractors, as well as a user's guide to working with the mid-level ResNet API).

This is not complete, and needs more work, but I think that can be done in a follow up PR. Some of the work is also dependent on the weights being ported successfully.

@theabhirath theabhirath requested a review from darsnack April 22, 2023 02:50
@theabhirath theabhirath added the documentation Documentation label Apr 22, 2023
@github-actions
Copy link
Contributor

Once the documentation build has completed, you can preview any updated documentation at this URL: https://fluxml.ai/Metalhead.jl/previews/PR221/

@CarloLucibello CarloLucibello merged commit ab061a1 into master Apr 23, 2023
@theabhirath theabhirath deleted the a2/docs-1-rebased branch April 25, 2023 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants