easy_ml 0.2.0.pre.rc2 → 0.2.0.pre.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff0824f8fce243fabbc5c0a7ea9e1eb1677b8efb3054f4198d7b40fe83596021
-  data.tar.gz: 881f8c4531565010f09d922530bbf17c9037b2cccf45e892148deb7eff98b484
+  metadata.gz: db28297feb27e35b04e013defa17654934a6e48fa026f8de382ae3ff8d4e6510
+  data.tar.gz: d4dcf27b88eaa6f42ff666ad7b16ef5e94ef42f61494c84656bdbd85183568d6
 SHA512:
-  metadata.gz: 9f3fd85d3a7161afd8ffd165523ece414e6bec18e8b3312afe07bc2c6f64c8e66dc192e2d085ea0a1ed00093478a8aee95d16ff93bee371b9cc37272ce5ab237
-  data.tar.gz: 1b7a0964fc587109f261f9d21694691283a8447104b9ca4c66140f83f5d2171fe3f92f1bfb4d9b406803c8452d5b0a89c7785943a1119aaa30ffe179603c0839
+  metadata.gz: 8d47bcb11e1c5f48de2817d8c3a89ebe5b750c44be84966b8bf50bda90456fba8faaf2e7dd5c10760d13fbb25d93882cc83100a4b0bc3fa9a72d241ac9f277c6
+  data.tar.gz: ecadf8354e78d1f2c3dceeaa0c7207900acf5b78a80b3b5f7a418815770a22304b77eb37a641c7b0be874b35a8c403316cf2c39c9416664d960a1a3402cd54c4

data/README.md

@@ -410,9 +410,17 @@ pip install wandb optuna
 
    ```bash
    rails generate easy_ml:migration
+   rails db:create # If this is a new app
    rails db:migrate
    ```
 
+3. Add the `easy_ml` dir to your `.gitignore` — This is where datasets and model files will be downloaded
+
+```
+# .gitignore
+easy_ml/
+```
+
 ## Usage
 
 To use EasyML in your Rails application, follow these steps:
@@ -456,7 +464,19 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 bundle exec appraisal install
 ```
 
-2. Ensure you run tests against all supported Rails versions
+1. Creating a test app:
+
+a. Follow the typical steps
+b. Declare an environment variable: `EASY_ML_DEV=true`, using Figaro, dotenv, or similar to load develoment assets
+c. Run `yarn vite dev` in both the `easy_ml` gem and test app directories
+
+1. Building production assets
+
+```bash
+bin/vite_build
+```
+
+1. Ensure you run tests against all supported Rails versions
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_ml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/easy_ml/blob/main/CODE_OF_CONDUCT.md).