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

Update 04_user_guide.md #218

Merged
merged 1 commit into from
Feb 10, 2024
Merged

Update 04_user_guide.md #218

merged 1 commit into from
Feb 10, 2024

Conversation

yukudemy
Copy link
Contributor

Fixed image paths.

Motivation and Context

The images were not showing because of the wrong paths

How has this been tested?

Just previewed

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change and added my name to the list of supporting contributions in the RELEASE.md file
  • Added tests to cover my changes
  • Assigned myself to the PR

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

  • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.

  • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorised to submit this contribution on behalf of the original creator(s) or their licensees.

  • I certify that the use of this contribution as authorised by the Apache 2.0 license does not violate the intellectual property rights of anyone else.

Fixed image paths.
@pjbqb pjbqb merged commit 121f6dd into mckinsey:develop Feb 10, 2024
2 checks passed
Jimmy-INL pushed a commit to Jimmy-INL/causalnex that referenced this pull request May 17, 2024
* adding setuptools requirement

* adding setuptools requirement
Jimmy-INL pushed a commit to Jimmy-INL/causalnex that referenced this pull request May 17, 2024
* Limiting numpy version (mckinsey#217)

* adding line on yml - no effect

* adding line on yml - no effect

* changing req.txt

* changing req.txt

* changing req.txt

* adding setuptools requirement (mckinsey#218)

* adding setuptools requirement

* adding setuptools requirement
Jimmy-INL pushed a commit to Jimmy-INL/causalnex that referenced this pull request May 17, 2024
* Limiting numpy version (mckinsey#217)

* adding line on yml - no effect

* adding line on yml - no effect

* changing req.txt

* changing req.txt

* changing req.txt

* adding setuptools requirement (mckinsey#218)

* adding setuptools requirement

* adding setuptools requirement

* update dictionaries to pass linting (mckinsey#230)

* Refactor/unlock numpy kl (mckinsey#235)

* unlocking numpy

* unlocking numpy

* unlocking numpy

* dependency fixes for docs and linters

* requirement fixes : numpy <1.24 for all python versions

---------

Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>

* Simplifying requirements - Numpy version range (mckinsey#236)

* Remove python 3.6 and 3.7 support (mckinsey#234)

* remove python 3.6 and 3.7 support

* update documentation

* remove comment regarding ignoring a warning when running `make build-docs`

* removing ipython from test requiremnets

* Update README.md

Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

---------

Co-authored-by: GabrielAz <gabriel.azevedoferreira@quantumblack.com>
Co-authored-by: Gabriel Azevedo Ferreira <57528979+GabrielAzevedoFerreiraQB@users.noreply.github.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

* unlocking numpy (#238)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release 0.11.2 (#239)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>
Jimmy-INL pushed a commit to Jimmy-INL/causalnex that referenced this pull request May 17, 2024
* Limiting numpy version (mckinsey#217)

* adding line on yml - no effect

* adding line on yml - no effect

* changing req.txt

* changing req.txt

* changing req.txt

* adding setuptools requirement (mckinsey#218)

* adding setuptools requirement

* adding setuptools requirement

* update dictionaries to pass linting (mckinsey#230)

* Refactor/unlock numpy kl (mckinsey#235)

* unlocking numpy

* unlocking numpy

* unlocking numpy

* dependency fixes for docs and linters

* requirement fixes : numpy <1.24 for all python versions

---------

Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>

* Simplifying requirements - Numpy version range (mckinsey#236)

* Remove python 3.6 and 3.7 support (mckinsey#234)

* remove python 3.6 and 3.7 support

* update documentation

* remove comment regarding ignoring a warning when running `make build-docs`

* removing ipython from test requiremnets

* Update README.md

Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

---------

Co-authored-by: GabrielAz <gabriel.azevedoferreira@quantumblack.com>
Co-authored-by: Gabriel Azevedo Ferreira <57528979+GabrielAzevedoFerreiraQB@users.noreply.github.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

* unlocking numpy (#238)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release 0.11.2 (#239)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>
Jimmy-INL pushed a commit to Jimmy-INL/causalnex that referenced this pull request May 17, 2024
* Replacing Pygraphviz with Pyvis

* Replacing Pygraphviz with Pyvis

* Replacing Pygraphviz with Pyvis

* temp (#242)

* Limiting numpy version (mckinsey#217)

* adding line on yml - no effect

* adding line on yml - no effect

* changing req.txt

* changing req.txt

* changing req.txt

* adding setuptools requirement (mckinsey#218)

* adding setuptools requirement

* adding setuptools requirement

* update dictionaries to pass linting (mckinsey#230)

* Refactor/unlock numpy kl (mckinsey#235)

* unlocking numpy

* unlocking numpy

* unlocking numpy

* dependency fixes for docs and linters

* requirement fixes : numpy <1.24 for all python versions

---------

Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>

* Simplifying requirements - Numpy version range (mckinsey#236)

* Remove python 3.6 and 3.7 support (mckinsey#234)

* remove python 3.6 and 3.7 support

* update documentation

* remove comment regarding ignoring a warning when running `make build-docs`

* removing ipython from test requiremnets

* Update README.md

Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

---------

Co-authored-by: GabrielAz <gabriel.azevedoferreira@quantumblack.com>
Co-authored-by: Gabriel Azevedo Ferreira <57528979+GabrielAzevedoFerreiraQB@users.noreply.github.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

* unlocking numpy (#238)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release 0.11.2 (#239)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* adding cython to config

* adding cython to config

* adding cython to config

* adding cython to config

---------

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>
Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Jimmy-INL pushed a commit to Jimmy-INL/causalnex that referenced this pull request May 17, 2024
* temp (#242)

* Limiting numpy version (mckinsey#217)

* adding line on yml - no effect

* adding line on yml - no effect

* changing req.txt

* changing req.txt

* changing req.txt

* adding setuptools requirement (mckinsey#218)

* adding setuptools requirement

* adding setuptools requirement

* update dictionaries to pass linting (mckinsey#230)

* Refactor/unlock numpy kl (mckinsey#235)

* unlocking numpy

* unlocking numpy

* unlocking numpy

* dependency fixes for docs and linters

* requirement fixes : numpy <1.24 for all python versions

---------

Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>

* Simplifying requirements - Numpy version range (mckinsey#236)

* Remove python 3.6 and 3.7 support (mckinsey#234)

* remove python 3.6 and 3.7 support

* update documentation

* remove comment regarding ignoring a warning when running `make build-docs`

* removing ipython from test requiremnets

* Update README.md

Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

---------

Co-authored-by: GabrielAz <gabriel.azevedoferreira@quantumblack.com>
Co-authored-by: Gabriel Azevedo Ferreira <57528979+GabrielAzevedoFerreiraQB@users.noreply.github.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

* unlocking numpy (#238)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release 0.11.2 (#239)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release Notes

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>
Jimmy-INL pushed a commit to Jimmy-INL/causalnex that referenced this pull request May 17, 2024
* Limiting numpy version (mckinsey#217)

* adding line on yml - no effect

* adding line on yml - no effect

* changing req.txt

* changing req.txt

* changing req.txt

* adding setuptools requirement (mckinsey#218)

* adding setuptools requirement

* adding setuptools requirement

* update dictionaries to pass linting (mckinsey#230)

* Refactor/unlock numpy kl (mckinsey#235)

* unlocking numpy

* unlocking numpy

* unlocking numpy

* dependency fixes for docs and linters

* requirement fixes : numpy <1.24 for all python versions

---------

Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>

* Simplifying requirements - Numpy version range (mckinsey#236)

* Remove python 3.6 and 3.7 support (mckinsey#234)

* remove python 3.6 and 3.7 support

* update documentation

* remove comment regarding ignoring a warning when running `make build-docs`

* removing ipython from test requiremnets

* Update README.md

Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

---------

Co-authored-by: GabrielAz <gabriel.azevedoferreira@quantumblack.com>
Co-authored-by: Gabriel Azevedo Ferreira <57528979+GabrielAzevedoFerreiraQB@users.noreply.github.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

* unlocking numpy (#238)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release 0.11.2 (#239)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Replacing Pygraphviz with Pyvis (mckinsey#237)

* Replacing Pygraphviz with Pyvis

* Replacing Pygraphviz with Pyvis

* Replacing Pygraphviz with Pyvis

* temp (#242)

* Limiting numpy version (mckinsey#217)

* adding line on yml - no effect

* adding line on yml - no effect

* changing req.txt

* changing req.txt

* changing req.txt

* adding setuptools requirement (mckinsey#218)

* adding setuptools requirement

* adding setuptools requirement

* update dictionaries to pass linting (mckinsey#230)

* Refactor/unlock numpy kl (mckinsey#235)

* unlocking numpy

* unlocking numpy

* unlocking numpy

* dependency fixes for docs and linters

* requirement fixes : numpy <1.24 for all python versions

---------

Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>

* Simplifying requirements - Numpy version range (mckinsey#236)

* Remove python 3.6 and 3.7 support (mckinsey#234)

* remove python 3.6 and 3.7 support

* update documentation

* remove comment regarding ignoring a warning when running `make build-docs`

* removing ipython from test requiremnets

* Update README.md

Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

---------

Co-authored-by: GabrielAz <gabriel.azevedoferreira@quantumblack.com>
Co-authored-by: Gabriel Azevedo Ferreira <57528979+GabrielAzevedoFerreiraQB@users.noreply.github.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

* unlocking numpy (#238)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release 0.11.2 (#239)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* adding cython to config

* adding cython to config

* adding cython to config

* adding cython to config

---------

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>
Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

* Replace pygraphviz plotting with pyvis (mckinsey#228)

* initial draft for pyvis plotting

* modify edge length and mass for strong style and return pyvis object

* add pytests and fix sklearn plotting function

* update to include pyvis in requirements

* add in notebook check tests for test_plot_dag

* downgrade pyvis for compatibility

* update to latest plotting functions

* update requirements to exclude pygraphviz

* upgrading ipython

* moving ipython as main requirement

* simplify plot_structure function

* remove unused code and add test cases when needed

* reset pyvis version to see if .show() is working on v0.3.1

* set ipython and python versions

* undo previous change (ipython version change)

* remove ipython version from requirements

* re-add ipython version to requirements

* change ipython+python version

* undo change ipython+python version

* check for different ipython versions

* add quotation marks in requirements.txt

* revert back to ipython>=8.10.0

* try out ipython requirements from kedro

* revert back to ipython>=8.10

* change ipython requirements to successfully create environments

* Updated pyvis tutorials (mckinsey#232)

* update tutorials and adjust default values to improve output

* allow user to change layout in plot_dag function before calling .show()

* display df without dataframe_image

* fix dataframe_image No such file or directory

* remove one cell beacause unused

* incorporate windows solution from Kyle

* fix typo

* change plot_structure documentation

* change plot_dag documentation

* check and correct all notebooks

* remove python 3.6 and 3.7 support

* update documentation

* remove comment regarding ignoring a warning when running `make build-docs`

* removing ipython from test requiremnets

* refactoring plot syntax and changing logic in plot_dag

* addressing Gabriel's comments

* removing unused IPython conditional import

* refactoring code to use display

* Docs - update 01-tutorial

* updating first tutotiral

* updating plotting tutorial

* updating plotting tutorial

* updating display api

* fixing bug - displau

* fixing notebooks

* fixing notebooks

* fixing notebooks

* fixing notebooks

* Replacing Pygraphviz with Pyvis

* Replacing Pygraphviz with Pyvis

* Replacing Pygraphviz with Pyvis

* updating pyvis version

* updating notebook

* Richard Comments - batch 1

* Update tests/test_plotting.py

Co-authored-by: Richard Oentaryo <oentaryorj@users.noreply.github.com>

* Update tests/test_plotting.py

Co-authored-by: Richard Oentaryo <oentaryorj@users.noreply.github.com>

* Richard Comments - batch 2

* adjust node color test to include background color

* docs

* docs

* test

* fixing mdlp with cython

* fixing mdlp with cython

* test

* removing cython from requirements

* adding cython to config

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: GabrielAz <gabriel.azevedoferreira@quantumblack.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>
Co-authored-by: Gabriel Azevedo Ferreira <57528979+GabrielAzevedoFerreiraQB@users.noreply.github.com>
Co-authored-by: Richard Oentaryo <oentaryorj@users.noreply.github.com>

* fix: requirements.txt to reduce vulnerabilities (#247)

The following vulnerabilities are fixed by pinning transitive dependencies:
- https://snyk.io/vuln/SNYK-PYTHON-IPYTHON-3318382

Co-authored-by: snyk-bot <snyk-bot@snyk.io>

* test

* Release Notes 0.12.0 (#249)

* temp (#242)

* Limiting numpy version (mckinsey#217)

* adding line on yml - no effect

* adding line on yml - no effect

* changing req.txt

* changing req.txt

* changing req.txt

* adding setuptools requirement (mckinsey#218)

* adding setuptools requirement

* adding setuptools requirement

* update dictionaries to pass linting (mckinsey#230)

* Refactor/unlock numpy kl (mckinsey#235)

* unlocking numpy

* unlocking numpy

* unlocking numpy

* dependency fixes for docs and linters

* requirement fixes : numpy <1.24 for all python versions

---------

Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>

* Simplifying requirements - Numpy version range (mckinsey#236)

* Remove python 3.6 and 3.7 support (mckinsey#234)

* remove python 3.6 and 3.7 support

* update documentation

* remove comment regarding ignoring a warning when running `make build-docs`

* removing ipython from test requiremnets

* Update README.md

Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

---------

Co-authored-by: GabrielAz <gabriel.azevedoferreira@quantumblack.com>
Co-authored-by: Gabriel Azevedo Ferreira <57528979+GabrielAzevedoFerreiraQB@users.noreply.github.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>

* unlocking numpy (#238)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release 0.11.2 (#239)

Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

* Release Notes

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>

---------

Co-authored-by: ElisabethSesterHussQB <92664441+ElisabethSesterHussQB@users.noreply.github.com>
Co-authored-by: kyle_lim <kyle_lim@mckinsey.com>
Co-authored-by: Philip Pilgerstorfer <34248114+qbphilip@users.noreply.github.com>
Co-authored-by: Gabriel Azevedo <gabriel_azevedo_ferreira@mckinsey.com>
Co-authored-by: Serene Yeo <118331898+SereneYeo@users.noreply.github.com>
Co-authored-by: Richard Oentaryo <oentaryorj@users.noreply.github.com>
Co-authored-by: Leon Nallamuthu <38660312+leonnallamuthu@users.noreply.github.com>
Co-authored-by: snyk-bot <snyk-bot@snyk.io>
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.

None yet

2 participants