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

duplication of seldon_core_setup notebook #1232

Closed
RafalSkolasinski opened this issue Dec 10, 2019 · 4 comments
Closed

duplication of seldon_core_setup notebook #1232

RafalSkolasinski opened this issue Dec 10, 2019 · 4 comments

Comments

@RafalSkolasinski
Copy link
Contributor

RafalSkolasinski commented Dec 10, 2019

When going through seldon-core docs I noticed that seldon_core_setup.ipynb is duplicated both in seldon-core/examples and seldon-core/notebooks.

The one linked from first tutorial notebook one hit when going through docs leads you to latter one that does not include info about ambassador port forwarding which may be confusing to new users.

We could remove duplication by creating a symlink and keeping around only one version of this notebook.

@ryandawsonuk
Copy link
Contributor

I agree it would be nice to do something about this. FWIW it looks to me like the port-forward is in both:

image

@RafalSkolasinski
Copy link
Contributor Author

oh, my bad, it's there but as a markdown cell whereas in other one it is executed directly from notebook,
editing issue to only mark duplication

@ryandawsonuk
Copy link
Contributor

ryandawsonuk commented Dec 10, 2019

The notebooks version is only referenced by a few notebooks so we could shift them to point to ../examples/seldon_core_setup.ipynb

image

I think the seldon_core_setup.html references need to stay as-is as they are just for the web version that refer to the readthedocs page generated from the nblink and the paths on those are different.

@ryandawsonuk
Copy link
Contributor

ryandawsonuk commented Dec 10, 2019

Actually we shouldn't do what I just suggested.

When you open a jupyter server with jupyter notebook then you can only refer as high as the base path from which you started it. So the it would be fine to remove the notebooks version if we were sure users were going to run the jupyter notebook command from the base seldon-core directory. But it's likely people will run this from the notebooks directory unless we tell them otherwise.

(Actually there's already a risk that people will run this command from a deeper-level directory - perhaps we should open an issue to make it clearer what we intend.)

Perhaps the symlink is a better idea.

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants