easy_ml 0.2.0.pre.rc1 → 0.2.0.pre.rc3

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: 62ec6069cb9e47af4d2fd29668202132af589b1fb526b93c8bd4766aec5df3b1
4
- data.tar.gz: 6e06d4e607d50b74f8d7ad5a881380d05bed58f351bc22357bfa3e5038850322
3
+ metadata.gz: db28297feb27e35b04e013defa17654934a6e48fa026f8de382ae3ff8d4e6510
4
+ data.tar.gz: d4dcf27b88eaa6f42ff666ad7b16ef5e94ef42f61494c84656bdbd85183568d6
5
5
  SHA512:
6
- metadata.gz: 61eed2f9f210fd5ac38af1b0972d369d73e5853491a5889c0b04c9dd776e5509514ab98ac56ab8e3bd876223a72a5463c29baa238899220acd369ee5e58c3206
7
- data.tar.gz: d266908a752c337c7817484af4235ba78b38e47495d25fe815feafad11b820cd63ca47300619c46f56971d810b2a475a3ebb2c436359026ff5f2f5f794cb0bd1
6
+ metadata.gz: 8d47bcb11e1c5f48de2817d8c3a89ebe5b750c44be84966b8bf50bda90456fba8faaf2e7dd5c10760d13fbb25d93882cc83100a4b0bc3fa9a72d241ac9f277c6
7
+ data.tar.gz: ecadf8354e78d1f2c3dceeaa0c7207900acf5b78a80b3b5f7a418815770a22304b77eb37a641c7b0be874b35a8c403316cf2c39c9416664d960a1a3402cd54c4
data/README.md CHANGED
@@ -397,8 +397,7 @@ Install necessary Python dependencies
397
397
  1. **Install Python dependencies (don't worry, all code is in Ruby, we just call through to Python)**
398
398
 
399
399
  ```bash
400
- pip install wandb
401
- pip install optuna
400
+ pip install wandb optuna
402
401
  ```
403
402
 
404
403
  1. **Install the gem**:
@@ -411,9 +410,17 @@ pip install optuna
411
410
 
412
411
  ```bash
413
412
  rails generate easy_ml:migration
413
+ rails db:create # If this is a new app
414
414
  rails db:migrate
415
415
  ```
416
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
+
417
424
  ## Usage
418
425
 
419
426
  To use EasyML in your Rails application, follow these steps:
@@ -457,7 +464,19 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
457
464
  bundle exec appraisal install
458
465
  ```
459
466
 
460
- 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
461
480
 
462
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).
463
482