easy_ml 0.2.0.pre.rc2 → 0.2.0.pre.rc4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ff0824f8fce243fabbc5c0a7ea9e1eb1677b8efb3054f4198d7b40fe83596021
4
- data.tar.gz: 881f8c4531565010f09d922530bbf17c9037b2cccf45e892148deb7eff98b484
3
+ metadata.gz: 0367d12137f6d3506e60e1f4a69546abdbf8524bef6c205754eddf30abb69c94
4
+ data.tar.gz: 05334be9021a5c0bd5cc372a981e9146632b2c4a9811329256de7b7f22db1cbf
5
5
  SHA512:
6
- metadata.gz: 9f3fd85d3a7161afd8ffd165523ece414e6bec18e8b3312afe07bc2c6f64c8e66dc192e2d085ea0a1ed00093478a8aee95d16ff93bee371b9cc37272ce5ab237
7
- data.tar.gz: 1b7a0964fc587109f261f9d21694691283a8447104b9ca4c66140f83f5d2171fe3f92f1bfb4d9b406803c8452d5b0a89c7785943a1119aaa30ffe179603c0839
6
+ metadata.gz: 1d47d5b96a8e6a065912d13377594658613b5f63eef936e1d0b7b89f2227c146ebd718604b983e1aba1dc6f2783a50b6815173e876f5acbf23d7f2db111d224b
7
+ data.tar.gz: c52f6bf90857fcf57753f04904f34cf73dd3fd4559dee14a6d32aae4b8a91b2a077380a16f85a10b97693d9e48b6ebf52f67e61114ca79f3eea7aae0ef81176f
data/README.md CHANGED
@@ -410,9 +410,17 @@ pip install wandb optuna
410
410
 
411
411
  ```bash
412
412
  rails generate easy_ml:migration
413
+ rails db:create # If this is a new app
413
414
  rails db:migrate
414
415
  ```
415
416
 
417
+ 3. Add the `easy_ml` dir to your `.gitignore` — This is where datasets and model files will be downloaded
418
+
419
+ ```
420
+ # .gitignore
421
+ easy_ml/
422
+ ```
423
+
416
424
  ## Usage
417
425
 
418
426
  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
456
464
  bundle exec appraisal install
457
465
  ```
458
466
 
459
- 2. Ensure you run tests against all supported Rails versions
467
+ 1. Creating a test app:
468
+
469
+ a. Follow the typical steps
470
+ b. Declare an environment variable: `EASY_ML_DEV=true`, using Figaro, dotenv, or similar to load develoment assets
471
+ c. Run `yarn vite dev` in both the `easy_ml` gem and test app directories
472
+
473
+ 1. Building production assets
474
+
475
+ ```bash
476
+ bin/vite_build
477
+ ```
478
+
479
+ 1. Ensure you run tests against all supported Rails versions
460
480
 
461
481
  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).
462
482