Merge branch 'main' into ingress-ray-dashboard

Author: Bobbins228

.gitattributes

@@ -0,0 +1 @@
+*.ipynb linguist-detectable=false

README.md

@@ -5,7 +5,10 @@
 
 An intuitive, easy-to-use python interface for batch resource requesting, access, job submission, and observation. Simplifying the developer's life while enabling access to high-performance compute resources, either in the cloud or on-prem.
 
-Tutorial and basics walkthrough coming soon!
+For guided demos and basics walkthroughs, check out the following links:
+ - Guided demo notebooks available [here](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos), and copies of the notebooks with [expected output](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/notebook-ex-outputs) also available
+ - Note that these notebooks will work with the latest `codeflare-sdk` PyPI release. For testing and experimentation with `main` branch, please use the [preview notebooks](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/preview_nbs)
+ - Additionally, we have a [video walkthrough](https://www.youtube.com/watch?v=U76iIfd9EmE) of these basic demos from June, 2023
 
 Full documentation can be found [here](https://project-codeflare.github.io/codeflare-sdk/)
 
@@ -62,7 +65,7 @@ The following instructions apply when doing release manually. This may be requir
 
 * Check and update the version in "pyproject.toml" file.
 * Generate new documentation.
-`pdoc --html -o docs src/codeflare_sdk && pushd docs && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd` (it is possible to install **pdoc** using the following command `poetry install --with docs`)
+`pdoc --html -o docs src/codeflare_sdk && pushd docs && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd && find docs -type f -name "*.html" -exec bash -c "echo '' >> {}" \;` (it is possible to install **pdoc** using the following command `poetry install --with docs`)
 * Commit all the changes to the repository.
 * Create Github release (https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release).
 * Build the Python package. `poetry build`

demo-notebooks/interactive/hf_interactive.ipynb renamed to demo-notebooks/additional-demos/hf_interactive.ipynb

@@ -53,11 +53,13 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Create authentication object for oc user permissions and login\n",
+    "# Create authentication object for user permissions\n",
+    "# IF unused, SDK will automatically check for default kubeconfig, then in-cluster config\n",
+    "# KubeConfigFileAuthentication can also be used to specify kubeconfig path manually\n",
     "auth = TokenAuthentication(\n",
     "    token = \"XXXX\",\n",
     "    server = \"XXXX\",\n",
-    "    skip_tls = True\n",
+    "    skip_tls = False\n",
     ")\n",
     "auth.login()"
    ]
@@ -88,13 +90,12 @@
     "# Create our cluster and submit appwrapper\n",
     "cluster = Cluster(ClusterConfiguration(name='hfgputest', \n",
     "                                       namespace=\"default\",\n",
-    "                                       min_worker=1, \n",
-    "                                       max_worker=1, \n",
+    "                                       num_workers=1,\n",
     "                                       min_cpus=8, \n",
     "                                       max_cpus=8, \n",
     "                                       min_memory=16, \n",
     "                                       max_memory=16, \n",
-    "                                       gpu=4,\n",
+    "                                       num_gpus=4,\n",
     "                                       image=\"quay.io/project-codeflare/ray:2.5.0-py38-cu116\",\n",
     "                                       instascale=True, machine_types=[\"m5.xlarge\", \"p3.8xlarge\"]))"
    ]
@@ -319,7 +320,9 @@
     "#install additional libraries that will be required for this training\n",
     "runtime_env = {\"pip\": [\"transformers\", \"datasets\", \"evaluate\", \"pyarrow<7.0.0\", \"accelerate\"]}\n",
     "\n",
-    "ray.init(address=f'{ray_cluster_uri}', runtime_env=runtime_env)\n",
+    "# NOTE: This will work for in-cluster notebook servers (RHODS/ODH), but not for local machines\n",
+    "# To see how to connect from your laptop, go to demo-notebooks/additional-demos/local_interactive.ipynb\n",
+    "ray.init(address=ray_cluster_uri, runtime_env=runtime_env)\n",
     "\n",
     "print(\"Ray cluster is up and running: \", ray.is_initialized())"
    ]

demo-notebooks/interactive/local_interactive.ipynb renamed to demo-notebooks/additional-demos/local_interactive.ipynb

@@ -44,7 +44,7 @@
     "cluster_name = \"hfgputest-1\"\n",
     "local_interactive = True\n",
     "\n",
-    "cluster = Cluster(ClusterConfiguration(local_interactive=local_interactive, namespace=namespace, name=cluster_name, min_worker=1, max_worker=1, min_cpus=1, max_cpus=1, min_memory=4, max_memory=4, gpu=0, instascale=False, machine_types=[\"m5.xlarge\", \"p3.8xlarge\"]))"
+    "cluster = Cluster(ClusterConfiguration(local_interactive=local_interactive, namespace=namespace, name=cluster_name, num_workers=1, min_cpus=1, max_cpus=1, min_memory=4, max_memory=4, num_gpus=0, instascale=False, machine_types=[\"m5.xlarge\", \"p3.8xlarge\"]))"
    ]
   },
   {
@@ -319,7 +319,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.8.17"
   },
   "vscode": {
    "interpreter": {