Skip to content

Commit

Permalink
review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
shaunyogeshwaran committed Dec 16, 2024
1 parent e7d82d8 commit 8cea901
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
18 changes: 9 additions & 9 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ See the [examples in this repository](https://github.com/h2oai/driverlessai-reci
- Create custom recipes for model interpretability, fairness, robustness, and explanations.
- Generate custom plots, charts, markdown reports, and more.

### Is Driverless AI sufficient without custom recipes?
Driverless AI continues to improve with each version, so you may not need custom recipes. However, adding your own recipes can optimize performance for specific use cases.
### Is H2O Driverless AI sufficient without custom recipes?
H2O Driverless AI continues to improve with each version, so you may not need custom recipes. However, adding your own recipes can optimize performance for specific use cases.

### What's in it for me if I write a recipe?
Writing recipes improves your data science skills and helps achieve better results. It is one of the best ways to enhance your expertise.
Expand All @@ -43,17 +43,17 @@ A text editor and knowledge of Python. Recipes are written as `.py` files with t
- Review the [examples in this repository](https://github.com/h2oai/driverlessai-recipes/blob/master/README.md#sample-recipes).
- Upload your recipe in the Expert Settings section during the experiment setup.

### What version of Python does Driverless AI use?
Driverless AI uses Python 3.6. Ensure your recipes are compatible with this version.
### What version of Python does H2O Driverless AI use?
H2O Driverless AI uses Python 3.6. Ensure your recipes are compatible with this version.

### How do I know if my recipe works?
Driverless AI will notify you whether your recipe passes the acceptance tests. If it fails, feedback will guide you on how to fix it.
H2O Driverless AI will notify you whether your recipe passes the acceptance tests. If it fails, feedback will guide you on how to fix it.

### How can I debug my recipe?
Upload your recipe to the Expert Settings and use the experiment log for debugging. Alternatively, make minimal changes as shown in [this debugging example](./transformers/how_to_debug_transformer.py) and debug with a Python debugger, like PyCharm.

### What happens if my recipe is rejected during upload?
Review the error message, which usually includes a stack trace and hints for fixing the issue. If you need help, ask questions in the [Driverless AI community Slack channel](https://www.h2o.ai/community/driverless-ai-community/#chat). You can also send your experiment logs zip file, which will contain the recipe source files.
Review the error message, which usually includes a stack trace and hints for fixing the issue. If you need help, ask questions in the [H2O Driverless AI community Slack channel](https://www.h2o.ai/community/driverless-ai-community/#chat). You can also send your experiment logs zip file, which will contain the recipe source files.

### What if my transformer recipe doesn't lead to the highest variable importance?
Features created by your transformer might not have the strongest signal, but they can still improve the overall model performance.
Expand All @@ -64,7 +64,7 @@ H2O Driverless AI will use the best-performing recipes. Check the experiment log
### Can I write recipes in Go, C++, Java, or R?
You can use any language as long as you can interface it with Python. Many recipes rely on Java and C++ backends.

### Is there a difference between custom recipes and those shipped with Driverless AI?
### Is there a difference between custom recipes and those shipped with H2O Driverless AI?
Custom recipes are treated the same as built-in recipes. There is no performance penalty or calling overhead.

### Why are some models implemented as transformers?
Expand All @@ -77,10 +77,10 @@ Recipes can be disabled by setting `enable_custom_recipes=false` in the `config.
When you upload a new version of a recipe, it becomes the default. Older experiments will continue using the previous version.

### Who can see my recipe?
Anyone with access to the Driverless AI instance can run any uploaded recipe, but recipes are shared only within the instance.
Anyone with access to the H2O Driverless AI instance can run any uploaded recipe, but recipes are shared only within the instance.

### How do I delete all recipes on my instance?
To delete all recipes, remove the `contrib` folder from the data directory (usually `tmp`) and restart Driverless AI. This will prevent old experiments from making predictions unless related experiments are also deleted.
To delete all recipes, remove the `contrib` folder from the data directory (usually `tmp`) and restart H2O Driverless AI. This will prevent old experiments from making predictions unless related experiments are also deleted.

### Are MOJOs supported for experiments that use custom recipes?
In most cases, MOJOs are not available for custom recipes. Contact [email protected] for more details.
Expand Down
14 changes: 7 additions & 7 deletions air-gapped_installations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ Air gapping is a network security measure used to isolate one or more computers
This guide walks you through the installation process of Custom Recipes in an air-gapped environment.

## Prerequisite
- Two DAI installations are required: one on an **Air-Gapped Machine** and the other on an **Internet-Facing Machine**. These terms will be used throughout the document for clarity.
- First, install DAI on the air-gapped machine (a machine isolated from the Internet). DAI can be installed using any available package type (e.g., TAR SH, Docker, DEB). You can download the installation packages from [H2O.ai Downloads](https://h2o.ai/resources/download/).
- On the Internet-facing machine, clone the repository and check out the appropriate branch for your DAI `VERSION`:
- Two H2O Driverless AI (DAI) installations are required: one on an **Air-Gapped Machine** and the other on an **Internet-Facing Machine**. These terms will be used throughout the document for clarity.
- First, install H2O Driverless AI on the air-gapped machine (a machine isolated from the Internet). Driverless AI can be installed using any available package type (e.g., TAR SH, Docker, DEB). You can download the installation packages from [H2O.ai Downloads](https://h2o.ai/resources/download/).
- On the Internet-facing machine, clone the repository and check out the appropriate branch for your Driverless AI `VERSION`:
```
git clone https://github.com/h2oai/driverlessai-recipes.git
cd driverlessai-recipes
git checkout rel-VERSION # eg. git checkout rel-1.9.0 for DAI 1.9.0
```

## Installation Guide
Follow the steps below to use custom recipes for DAI in an air-gapped environment:
Follow the steps below to use custom recipes for H2O Driverless AI in an air-gapped environment:

**Note**: *These steps should be performed on the Internet-Facing Machine.*

1. Download the required version of the Driverless AI TAR SH installer on the Internet-Facing Machine from [H2O.ai Downloads](https://www.h2o.ai/download/).
1. Download the required version of the H2O Driverless AI TAR SH installer on the Internet-Facing Machine from [H2O.ai Downloads](https://www.h2o.ai/download/).

2. Run the following commands to install the Driverless AI TAR SH. Replace `VERSION` with the specific version you need.
2. Run the following commands to install the H2O Driverless AI TAR SH. Replace `VERSION` with the specific version you need.
```
chmod 755 dai-VERSION.sh
./dai-VERSION.sh
Expand Down Expand Up @@ -62,7 +62,7 @@ Follow the steps below to use custom recipes for DAI in an air-gapped environmen
6. Once the script has been executed successfully, custom recipes and Python dependencies will be installed in the `dai-VERSION/<data_directory>/<user>/contrib` directory, where `<data_directory>` is `tmp` by default.
7. Zip the `dai-VERSION/tmp/contrib` directory and move it to the air-gapped machine. Unzip it into the DAI `tmp` directory:
7. Zip the `dai-VERSION/tmp/contrib` directory and move it to the air-gapped machine. Unzip it into the Driverless AI `tmp` directory:
```
cd dai-VERSION/`<data_directory>`/
zip -r user_contrib.zip `<user>`/contrib
Expand Down

0 comments on commit 8cea901

Please sign in to comment.