Skip to content

Commit 9bfca4b

Browse files
authored
Doc update for rai vision (#2164)
1 parent a7cb6ec commit 9bfca4b

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,9 @@ cypress window will open locally - select test file to run the tests
139139
2. `cd responsible-ai-toolbox` (It is recommended to create a new virtual environment and install the dependencies)
140140
3. `yarn install`
141141
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.
144145

145146
If there are changes to other python packages, you will want to install them locally as well:
146147

@@ -154,9 +155,9 @@ cypress window will open locally - select test file to run the tests
154155

155156
If there are no changes to them, then raiwidgets install will pick up the latest versions released on pypi.
156157

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`
160161

161162
Cypress window will open locally - select test file to run the tests.
162163

@@ -190,15 +191,16 @@ For any new change, which involves changing any of the python SDK components and
190191
3. You should commit all your current set of changes for SDK and UX using `git commit`.
191192
4. Clean all untracked files using `git clean -fdx`
192193
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.
202204

203205
The steps from 3 to 14 need to be repeated if you incrementally change UI or SDK.
204206

0 commit comments

Comments
 (0)