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.

Sign up for GitHub

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

Jump to bottom

Update documentation #880

Merged
merged 98 commits into from
Feb 14, 2025
Merged

Update documentation #880

merged 98 commits into from
Feb 14, 2025

Conversation

PythonFZ
Copy link
Member

@PythonFZ PythonFZ commented Feb 13, 2025 •
edited
Loading

  • 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
  • fix README.md example (see gitmodule)
  • always_changed=True
  • mlflow

PythonFZ and others added 30 commits February 1, 2025 15:44
@PythonFZ
update README example
85034e9
@PythonFZ
add more text
2778f0c
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
ac35403 
for more information, see https://pre-commit.ci
@PythonFZ
add load example
d263ad6
@PythonFZ
add mlipx and ipsuite example code
e972795
@PythonFZ
run through LLM
f189921
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
d6949a4 
for more information, see https://pre-commit.ci
@PythonFZ
update
165cb25
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
1c30687 
for more information, see https://pre-commit.ci
@PythonFZ
a bit more text
f2ad54e
@PythonFZ
Merge branch '132-improve-readme' of https://github.com/zincware/ZnTrack
4970f8f 
 into 132-improve-readme
@PythonFZ
more example text
339f26e
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
0efb366 
for more information, see https://pre-commit.ci
@PythonFZ
update README.md
a93c69d
@PythonFZ
update readme
2227289
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
62a3e5d 
for more information, see https://pre-commit.ci
@PythonFZ
do not use mdformatter
0cc27e9
@PythonFZ
fix tip
db5bd01
@PythonFZ
Update README.md
f4403c0
@PythonFZ
Update README.md
24e6971
@PythonFZ
Update README.md
8f4d0ce
@PythonFZ
Update README.md
272afc2
@PythonFZ
update docs
ce3ae44
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
3fddbc1 
for more information, see https://pre-commit.ci
@PythonFZ
update docs
60b180b
@PythonFZ
update docstrings
042ef4f
@PythonFZ
update type hints
4af5db3
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
8fbb5a8 
for more information, see https://pre-commit.ci
@PythonFZ
Merge branch 'main' into 132-improve-readme
acff943
@PythonFZ
update glossaries
2ad5a11
@PythonFZ PythonFZ mentioned this pull request Feb 13, 2025
Closed
1 task
@PythonFZ PythonFZ merged commit 72f96ca into main Feb 14, 2025
10 of 11 checks passed
@PythonFZ PythonFZ deleted the docs branch February 14, 2025 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@PythonFZ