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

VGG has two "higher-level" functions #269

Closed
theabhirath opened this issue Jan 3, 2024 · 1 comment · Fixed by #270
Closed

VGG has two "higher-level" functions #269

theabhirath opened this issue Jan 3, 2024 · 1 comment · Fixed by #270

Comments

@theabhirath
Copy link
Member

VGG currently has two functions in the "higher-level" API category (as per the camel-casing nomenclature):

VGG(imsize::Dims{2}; config, inchannels, batchnorm = false, nclasses, fcsize, dropout_prob)
VGG(depth::Integer; pretrain::Bool = false, batchnorm::Bool = false, inchannels::Integer = 3, nclasses::Integer = 1000)

The former is probably an artifact of pre-0.8 Metalhead, since there is also a mid-level function for VGG with a very similar API:

vgg(imsize; config, inchannels, batchnorm = false, nclasses, fcsize, dropout_prob)

This came up in #268, where the pre-trained version of VGG has its docstring hidden. We can work around this I believe by writing a single docstring with both variants, but if it is agreeable maybe we can deprecate the first function above for uniformity?

@darsnack
Copy link
Member

darsnack commented Jan 3, 2024

Let's deprecate the first version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants