search

lf1-io / padl

Functional deep learning
Apache License 2.0
106 stars 4 forks source link

Docs update #433

Closed sjrl closed 2 years ago

sjrl commented 2 years ago

Description

Update the docs to tell users that PADL is not expected to work in the base Python Interpreter environment. This has to do with frames not containing the source code needed by the inspect module. This is explained in a bit more detail here: https://stackoverflow.com/questions/63347543/python-inspect-stack-returns-frameinfo-objects-with-missing-code-context-a

@wuhu @jasonkhadka Please let me know if we should reword the warning or if there is a more appropriate place to put it.

jasonkhadka commented 2 years ago

We can bypass this by avoiding inspection when calling with a normal python console right? We could avoid call_info and other inspections if it is not possible. Saving will not work there, but anyway working in the normal console is only useful for quick debugging purposes. Again a very rare use-case, that we should discuss if we want to support.

codecov-commenter commented 2 years ago

Codecov Report

Merging #433 (24b57f6) into main (547d07e) will increase coverage by 0.80%. The diff coverage is 89.65%.

@@            Coverage Diff             @@
##             main     #433      +/-   ##
==========================================
+ Coverage   88.20%   89.01%   +0.80%     
==========================================
  Files          15       15              
  Lines        3060     3003      -57     
==========================================
- Hits         2699     2673      -26     
+ Misses        361      330      -31
Impacted Files Coverage Δ
padl/dumptools/var2mod.py 94.83% <ø> (+2.06%) :arrow_up:
padl/dumptools/symfinder.py 87.73% <72.22%> (+3.04%) :arrow_up:
padl/dumptools/packagefinder.py 96.55% <96.00%> (+1.42%) :arrow_up:
padl/dumptools/inspector.py 93.40% <100.00%> (+0.01%) :arrow_up:
padl/transforms.py 91.20% <100.00%> (-0.13%) :arrow_down:
padl/wrap.py 90.60% <0.00%> (+0.60%) :arrow_up:
... and 2 more

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 e340168...24b57f6. Read the comment docs.

sjrl commented 2 years ago

Again a very rare use-case, that we should discuss if we want to support.

I've made an issue for this https://github.com/lf1-io/padl/issues/434