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

refactor: general cleanup of internals and documentation #47

Merged
merged 14 commits into from
Aug 24, 2024
Merged

Conversation

avik-pal
Copy link
Member

@avik-pal avik-pal commented Aug 23, 2024

Main Changes

  • similar to other changes in LuxDL packages, code is organized in submodules
  • uses public to specify that is public and what isn't
    • Layers
    • Vision
    • Basis
  • @compact layers are great but are mostly meant to be used in research codebases (see recent discussion in NeuralOperators.jl)

Documentation

Documentation hosting going forward will be:

  1. If Lux depends on the package: documentation will be hosted on the central docs.
  2. If the package builds on top of Lux, it needs a dedicated docs site.

The reasoning is quite simple: currently making a breaking change in Lux creates a deadlock in docs building since Boltz needs to be updated before we can build the docs for lux and we can't release lux till docs build (since we have actual tests inside lux).

@avik-pal avik-pal force-pushed the ap/cleanup branch 2 times, most recently from d4d0bd2 to 9842802 Compare August 24, 2024 00:05
@avik-pal avik-pal force-pushed the ap/cleanup branch 2 times, most recently from c0ceae6 to dc2a1f9 Compare August 24, 2024 01:17
Copy link

codecov bot commented Aug 24, 2024

Codecov Report

Attention: Patch coverage is 81.75182% with 25 lines in your changes missing coverage. Please review.

Project coverage is 88.79%. Comparing base (6a97386) to head (5600531).
Report is 15 commits behind head on main.

Files Patch % Lines
src/utils.jl 55.88% 15 Missing ⚠️
ext/BoltzMetalheadExt.jl 86.66% 2 Missing ⚠️
src/layers/hamiltonian.jl 80.00% 2 Missing ⚠️
src/layers/mlp.jl 71.42% 2 Missing ⚠️
src/patch.jl 50.00% 2 Missing ⚠️
src/basis.jl 92.30% 1 Missing ⚠️
src/vision/extensions.jl 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #47      +/-   ##
==========================================
- Coverage   91.84%   88.79%   -3.06%     
==========================================
  Files          22       22              
  Lines         319      339      +20     
==========================================
+ Hits          293      301       +8     
- Misses         26       38      +12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@avik-pal avik-pal merged commit b001128 into main Aug 24, 2024
15 of 17 checks passed
@avik-pal avik-pal deleted the ap/cleanup branch August 24, 2024 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant