Comments (2)
- automate.py script goes through whole library and gathers funbctions and classes
puts them into mkgendocs.yml - gendocs util tranforms mkgendocs.yml into .md files in docs_mk
- mkdocs build tranforms md files in docs_mk into documentation in /site
- [optional] mkdocs serve will create http server to check the documentation
- [optional] running of automate script can be part of prehook, but this add additional overhead so I think it's enough to keep the procedure only in readme.md or somewhere else
notes:
- mkdocs does not like classes without init(), so I added init(self):pass where it was missing
- automate script uses improtlib which does not like relative imports so I changed relative import "from .wdtypes import *" at couple of places to absolute path
procedure to generate documentation (all in root dir):
pip install -r mkdocs_requirements.txt
python automate.py
gendocs --config mkgendocs.yml
mkdocs build
# if you want to run webserver
# mkdocs serve
from pytorch-widedeep.
- jupyternotebook are now displayed in documentation - each notebook has to start with level 1 heading, I adjusted couple of notebooks that started with level 2
- mkgendocs copies everything from templates dir to sources_dir (sources_dir is recreated each time), if we want to have examples/notebooks/*.ipynb in the documentation we have to copy them to templates ourselves - fixed it at the end of automate.py
- markdown "image links" in readme.md were not displayed correctly, I changed them to HTML - fixed
- I changed mknotebooks plugin to mkdocs-jupyter as new one includes scrollbar if printout is wider than width of webpage(eg pandas with many columns)
- I copied webpage(documentation) related files (pictures, favicon, etc) to docs_mk/templates, again as contents of this directory is copied to docs_mk/sources when gendocs is run
summary
new documentation looks awesome! @jrzaurin let me know when you have time and I can give you 15min tour how it works, afterwards I create pullrequest to merge the changes
from pytorch-widedeep.
Related Issues (20)
- Not Being able to reproduce Bert results HOT 5
- pytorch vision module error HOT 1
- save_best_only error and NaN during training HOT 9
- CyclicLR throws ZeroDivisionError when finetuning with a single batch. HOT 2
- EarlyStopping does not store and restore the model HOT 5
- Can I use time series data HOT 6
- CUDA error: device-side assert triggered HOT 5
- Wrong paper links on ContrastiveDenoisingTrainer HOT 2
- how to save the best Epoch HOT 11
- Dropout layer being created on forward pass (in MultiHeadedAttention) HOT 1
- about Wide's input dim HOT 5
- ImportError: cannot import name 'LRScheduler' from 'torch.optim.lr_scheduler' HOT 8
- OSError when importing the package HOT 4
- AttributeError: 'TabMlp' object has no attribute 'with_fds' HOT 3
- Colab session crash on .fit HOT 3
- IndexError: index out of range in self HOT 4
- how to use lr warmup in traing stage? HOT 3
- Problems running transformer models HOT 5
- 'TextPreprocessor' object has no attribute 'embedding_matrix' HOT 6
- How to install the previous version, the current 1.5 version has been working problems? HOT 14
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pytorch-widedeep.