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

Improve README #878

Closed
wants to merge 42 commits into from
Closed

Improve README #878

wants to merge 42 commits into from

Conversation

PythonFZ
Copy link
Member

@PythonFZ PythonFZ commented Feb 1, 2025

  • on/off graph dataclasses
  • integration with paraffin
  • how dvc and params files look like / more examples, e.g from readme
  • tip on how large a node should be
  • zntrack.apply
  • something about modern python, typer, fastapi, sqlmodel,... copy text
  • everything goes through files, example for how to bring stuff on the graph, tip on outs/inps/run multiple methods to split complexity
  • diff between pparams and deps, currently a bit hidden
  • config.always_cache
  • self.state.fs
  • self.state.restarted
  • node-meta.json

@PythonFZ PythonFZ linked an issue Feb 1, 2025 that may be closed by this pull request
Copy link

codecov bot commented Feb 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.25%. Comparing base (3433220) to head (f4403c0).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #878      +/-   ##
==========================================
- Coverage   90.45%   90.25%   -0.20%     
==========================================
  Files          32       32              
  Lines        1698     1694       -4     
  Branches      293      293              
==========================================
- Hits         1536     1529       -7     
- Misses        162      165       +3     
Flag Coverage Δ
fulltest 90.25% <ø> (-0.20%) ⬇️

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

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

@PythonFZ PythonFZ requested a review from MrJulEnergy February 3, 2025 09:34
@PythonFZ PythonFZ marked this pull request as ready for review February 12, 2025 18:05
@PythonFZ PythonFZ closed this Feb 13, 2025
@PythonFZ PythonFZ deleted the 132-improve-readme branch February 13, 2025 07:42
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.

Improve readme
1 participant