kubeflow
/
examples
mirror of https://github.com/kubeflow/examples.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
examples/code_search
History
dependabot[bot] 038e9d5f07
Bump urijs from 1.19.7 to 1.19.10 in /code_search/src/ui 
Bumps [urijs](https://github.com/medialize/URI.js) from 1.19.7 to 1.19.10.
- [Release notes](https://github.com/medialize/URI.js/releases)
- [Changelog](https://github.com/medialize/URI.js/blob/gh-pages/CHANGELOG.md)
- [Commits](https://github.com/medialize/URI.js/compare/v1.19.7...v1.19.10)

---
updated-dependencies:
- dependency-name: urijs
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2022-03-08 23:40:04 +00:00
..
demo Update the ArgoCD app to use the kubeflow/examples repo (#440) 2018-12-19 21:26:49 -08:00
docker An Argo workflow to use as the E2E test for code_search example. (#446) 2018-12-28 16:12:32 -08:00
ks-web-app Fix the web app. (#432) 2018-12-12 09:24:40 -08:00
kubeflow Add preprocess github data step to code search pipeline (#396) 2018-12-05 18:06:06 -08:00
pipeline Minor fixes to the notebook. (#427) 2019-01-15 08:33:19 -08:00
src Bump urijs from 1.19.7 to 1.19.10 in /code_search/src/ui 2022-03-08 23:40:04 +00:00
.dockerignore Remove ksonnet registry from dockerignore file (#333) 2018-11-14 13:45:15 -08:00
.gitignore code search example make distributed training work; Create some components to train models (#317) 2018-11-08 16:13:01 -08:00
Makefile An Argo workflow to use as the E2E test for code_search example. (#446) 2018-12-28 16:12:32 -08:00
OWNERS Add IronPan to code_search owner (#386) 2018-11-30 17:37:57 -08:00
README.md Setup ArgoCD to synchornize the code search web app with the demo cluster. (#359) 2018-11-26 18:19:19 -08:00
code-search.ipynb Setup ArgoCD to synchornize the code search web app with the demo cluster. (#359) 2018-11-26 18:19:19 -08:00
developer_guide.md An Argo workflow to use as the E2E test for code_search example. (#446) 2018-12-28 16:12:32 -08:00

README.md

Code Search on Kubeflow

This demo implements End-to-End Code Search on Kubeflow.

Warning: Running this example can be very expensive

This example uses large amounts of computation and cost several hundred dollars to run E2E on Cloud.

Prerequisites

NOTE: If using the JupyterHub Spawner on a Kubeflow cluster, use the Docker image gcr.io/kubeflow-images-public/kubeflow-codelab-notebook which has baked all the pre-prequisites.

  • Kubeflow Latest This notebook assumes a Kubeflow cluster is already deployed. See Getting Started with Kubeflow.

  • Python 2.7 (bundled with pip) For this demo, we will use Python 2.7. This restriction is due to Apache Beam, which does not support Python 3 yet (See BEAM-1251).

  • Google Cloud SDK This example will use tools from the Google Cloud SDK. The SDK must be authenticated and authorized. See Authentication Overview.

  • Ksonnet 0.12 We use Ksonnet to write Kubernetes jobs in a declarative manner to be run on top of Kubeflow.

Getting Started

To get started, follow the instructions below.

NOTE: We will assume that the Kubeflow cluster is available at kubeflow.example.com. Make sure you replace this with the true FQDN of your Kubeflow cluster in any subsequent instructions.

  • Spawn a new JupyterLab instance inside the Kubeflow cluster by pointing your browser to https://kubeflow.example.com/hub and clicking "Start My Server".

  • In the Image text field, enter gcr.io/kubeflow-images-public/kubeflow-codelab-notebook:v20180808-v0.2-22-gcfdcb12. This image contains all the pre-requisites needed for the demo.

  • Once spawned, you should be redirected to the Jupyter Notebooks UI.

  • Spawn a new Terminal and run

    $ git clone --branch=master --depth=1 https://github.com/kubeflow/examples

    This will create an examples folder. It is safe to close the terminal now.

  • Navigate back to the Jupyter Notebooks UI and navigate to examples/code_search. Open the Jupyter notebook code-search.ipynb and follow it along.

Acknowledgements

This project derives from hamelsmu/code_search.