📝 fix documentation & examples

[aniketmaurya]

Changes

Fixes #157 - removed deprecated examples

Type of change

• [ ] 📚 Documentation Update
• [ ] 🧪 Tests Cases
• [x] 🐞 Bug fix (non-breaking change which fixes an issue)
• [ ] 🔬 New feature (non-breaking change which adds functionality)
• [ ] 🚨 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [x] 📝 This change requires a documentation update

Checklist

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] Did you update CHANGELOG (docs/CHANGELOG.md) in case of a major change?

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[sonarcloud[bot]]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[codecov[bot]]

Codecov Report

Merging #158 (3aa9f32) into main (436dc96) will increase coverage by 0.00%. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #158   +/-   ##
=======================================
  Coverage   96.92%   96.93%           
=======================================
  Files          66       66           
  Lines        1917     1922    +5     
=======================================
+ Hits         1858     1863    +5     
  Misses         59       59           

Flag	Coverage Δ
unittests	96.93% <100.00%> (+<0.01%)	:arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
gradsflow/models/base.py	88.28% <ø> (-0.61%)	:arrow_down:
gradsflow/models/model.py	98.48% <100.00%> (+0.15%)	:arrow_up:
tests/models/test_model.py	98.43% <100.00%> (-0.03%)	:arrow_down:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 436dc96...3aa9f32. Read the comment docs.