You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-14Lines changed: 16 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -139,8 +139,9 @@ cypress window will open locally - select test file to run the tests
139
139
2.`cd responsible-ai-toolbox` (It is recommended to create a new virtual environment and install the dependencies)
140
140
3.`yarn install`
141
141
4.`yarn buildall` or `yarn build widget`
142
-
5.`pip install -e raiwidgets` to install raiwidgets locally.
143
-
6.`pip install -e responsibleai` to install responsibleai locally.
142
+
5.`pip install -e responsibleai_vision` if using the RAI Vision Dashboard locally.
143
+
6.`pip install -e raiwidgets` to install raiwidgets locally.
144
+
7.`pip install -e responsibleai` to install responsibleai locally.
144
145
145
146
If there are changes to other python packages, you will want to install them locally as well:
146
147
@@ -154,9 +155,9 @@ cypress window will open locally - select test file to run the tests
154
155
155
156
If there are no changes to them, then raiwidgets install will pick up the latest versions released on pypi.
156
157
157
-
7.`pip install jupyter`
158
-
8.`cd notebooks\responsibleaidashboard`
159
-
9. To execute tests run `yarn e2e-widget`. Sometimes it is preferable to watch the execution and select only individual test cases. This is possible by running the notebook manually and using `yarn e2e-widget -w --host {host} -n {notebook}` where host is where RAI widget runs on (printed in notebook output) and notebook is the name of the notebook you are running. Eg: `yarn e2e-widget -w --host 5000 -n responsibleaidashboard-census-classification-model-debugging`
158
+
8.`pip install jupyter`
159
+
9.`cd notebooks\responsibleaidashboard`
160
+
10. To execute tests run `yarn e2e-widget`. Sometimes it is preferable to watch the execution and select only individual test cases. This is possible by running the notebook manually and using `yarn e2e-widget -w --host {host} -n {notebook}` where host is where RAI widget runs on (printed in notebook output) and notebook is the name of the notebook you are running. Eg: `yarn e2e-widget -w --host 5000 -n responsibleaidashboard-census-classification-model-debugging`
160
161
161
162
Cypress window will open locally - select test file to run the tests.
162
163
@@ -190,15 +191,16 @@ For any new change, which involves changing any of the python SDK components and
190
191
3. You should commit all your current set of changes for SDK and UX using `git commit`.
191
192
4. Clean all untracked files using `git clean -fdx`
192
193
5. Run `yarn install` and `yarn buildall` to build the UX changes.
193
-
6. Run `pip install -e raiwidgets` to install raiwidgets locally.
194
-
7. Run `pip install -e responsibleai` to install responsibleai locally.
195
-
8. Run `pip install -e erroranalysis` to install erroranalysis locally.
196
-
9. Run `pip install -e rai_core_flask` to install rai_core_flask locally.
197
-
10. Run `pip install -e raiutils` to install raiutils locally.
198
-
11. Run `pip install -e nlp_feature_extractors` to install nlp_feature_extractors locally if using the RAI Text Dashboard.
199
-
12. Run `pip install -e rai_test_utils` to install rai_test_utils locally.
200
-
13. Install `jupyter` using `pip install jupyter`
201
-
14. Open any notebook using python SDK and any widget from `responsible-ai-toolbox` and test your changes.
194
+
6. Run `pip install -e responsibleai_vision` if using the RAI Vision Dashboard locally.
195
+
7. Run `pip install -e raiwidgets` to install raiwidgets locally.
196
+
8. Run `pip install -e responsibleai` to install responsibleai locally.
197
+
9. Run `pip install -e erroranalysis` to install erroranalysis locally.
198
+
10. Run `pip install -e rai_core_flask` to install rai_core_flask locally.
199
+
11. Run `pip install -e raiutils` to install raiutils locally.
200
+
12. Run `pip install -e nlp_feature_extractors` to install nlp_feature_extractors locally if using the RAI Text Dashboard.
201
+
13. Run `pip install -e rai_test_utils` to install rai_test_utils locally.
202
+
14. Install `jupyter` using `pip install jupyter`
203
+
15. Open any notebook using python SDK and any widget from `responsible-ai-toolbox` and test your changes.
202
204
203
205
The steps from 3 to 14 need to be repeated if you incrementally change UI or SDK.
0 commit comments