Create API endpoint for proximity analysis #53

yaroluchko · 2021-07-22T23:33:18Z

This pull request:

creates the API endpoint for the proximity analysis posting
creates an API endpoint for viewing all the proximity analyses
adds the urls for the two API endpoints above
adds a manual test in the proximity_test.py file

Co-Authored-By: yaroluchko <85574367+yaroluchko@users.noreply.github.com>

…ithub.com/dhmit/gender_analysis_web into create_API_endpoint_for_proximityAnalysis

This creates the Proximity Analysis API endpoint and a way to see all the analyses

A manual test for proximity posting

Fix unncessary result calculation if already done before

joshfeli · 2021-07-22T23:39:46Z

Just to note: The proximity_frontend branch has this copied and pasted to test the endpoint with the button in place, and all data passes through successfully! We were able to at least get the console to print out the results object, but this will be replaced with a display function.

MBJean

This generally looks great! Thanks for your updates. I've left a few comments below. I'd be interested in seeing a more comprehensive test, if possible.

MBJean · 2021-07-23T00:08:38Z

backend/app/views.py

+            'word_window': word_window,
+            'results': results,
+        }
+


Ultimately, we may want to change this up so that you call a ProximityAnalysisManager or similar (like we do with the DocumentManager) when we create this new ProximityAnalysis, and have the ProximityAnalysisManager call the run_analysis function. That is: since a ProximityAnalysis necessarily relies on the run_analysis function, we could use the ProximityAnalysis itself (through a Manager) to ensure that run_analysis is run when a new instance is created. That would more tightly couple associated functionality. That said, since this is working and is well tested, we can leave it be for now and come back to it later.

MBJean · 2021-07-23T00:13:07Z

backend/app/analysis/proximity_test.py

+    factory = APIRequestFactory()
+    request = factory.post('api/all_proximity', {'word_window': '2', 'corpus_id': c1.id})
+    add_proximity_analysis(request)
+


Was this test used simply to manually ensure that the full ProximityAnalysis creation occurred as expected? Would it be possible to add something to our larger test suite so we can check that the model instance is saved as expected?

Yea, this was just a manual test. I will try and add a more comprehensive test.

I've just added a test to the tests.py file that makes sure the post request is successful

`frequency.py` also has a `run_analysis` function; this change will prevent aliasing errors should the other team import the `frequency` counterpart into `views.py`.

commit 0fdfcc6 Merge: 1276da0 b10cfa9 Author: Peihua Huang <32581282+phuang00@users.noreply.github.com> Date: Fri Jul 23 15:48:02 2021 -0400 Merge pull request #25 from dhmit/transfer_frequency_module_PR1 Transfer frequency module pr1 commit 1276da0 Merge: 657b20f b5a9482 Author: YifanWang0 <47550739+YifanWang0@users.noreply.github.com> Date: Fri Jul 23 15:38:12 2021 -0400 Merge pull request #54 from dhmit/transfer_frequency_model Added FrequencyAnalysis model commit b5a9482 Author: Yifan Wang <yifan.wang0422@gmail.com> Date: Fri Jul 23 14:08:54 2021 -0400 added FrequencyAnalysis model commit b10cfa9 Author: Peihua Huang <nemesis2126@gmail.com> Date: Fri Jul 23 13:41:17 2021 -0400 update run_analysis to use primary keys instead of labels and update result dictionary to key by gender object commit 1196fc1 Author: Peihua Huang <nemesis2126@gmail.com> Date: Fri Jul 23 13:36:54 2021 -0400 Revert "update frequency result to key by gender primary key instead of label" This reverts commit 151a4bc. commit 151a4bc Author: Peihua Huang <nemesis2126@gmail.com> Date: Fri Jul 23 13:34:11 2021 -0400 update frequency result to key by gender primary key instead of label commit 657b20f Merge: 6619e68 3c6e5bf Author: Joshua Feliciano <41080599+joshfeli@users.noreply.github.com> Date: Fri Jul 23 11:42:15 2021 -0400 Merge pull request #52 from dhmit/remove_proximity_breakpoint Removed debugging breakpoint commit 3c6e5bf Author: Joshua Feliciano <joshfeli613@gmail.com> Date: Thu Jul 22 17:50:15 2021 -0400 Removed debugging breakpoint commit 0684a02 Author: Peihua Huang <nemesis2126@gmail.com> Date: Thu Jul 22 16:43:50 2021 -0400 got frequency analysis working with a corpus commit 2003ce6 Author: Peihua Huang <nemesis2126@gmail.com> Date: Thu Jul 22 16:28:27 2021 -0400 convert run_analysis to run_single_analysis, such that the function only takes in one document and update docstrings and added test commit 0f817ba Merge: dc21391 6619e68 Author: Peihua Huang <nemesis2126@gmail.com> Date: Thu Jul 22 14:54:15 2021 -0400 Merge branch 'main' into transfer_frequency_module_PR1 commit dc21391 Author: Yifan Wang <yifan.wang0422@gmail.com> Date: Wed Jul 7 16:44:55 2021 -0400 fixed small mistakes according to pr comments commit a852cd3 Author: Yifan Wang <yifan.wang0422@gmail.com> Date: Mon Jun 28 16:42:28 2021 -0400 added docstrings commit 32731f4 Author: Yifan Wang <yifan.wang0422@gmail.com> Date: Mon Jun 28 16:01:57 2021 -0400 fixed minor bug with _run_analysis function commit 233e2e6 Author: Yifan Wang <yifan.wang0422@gmail.com> Date: Fri Jun 25 16:52:31 2021 -0400 moved over run analysis but still need to fix bug with helper function

Watermelanie and others added 11 commits July 21, 2021 17:09

created an API endpoint for posting proximity analysis

f3114ec

Co-Authored-By: yaroluchko <85574367+yaroluchko@users.noreply.github.com>

Resolved __hash__ error

4d88605

Merge branch 'main' into create_API_endpoint_for_proximityAnalysis

efdee64

Merge branch 'main' into create_API_endpoint_for_proximityAnalysis

c48ca53

Merge branch 'create_API_endpoint_for_proximityAnalysis' of https://g…

6a5b6f9

…ithub.com/dhmit/gender_analysis_web into create_API_endpoint_for_proximityAnalysis

Merge branch 'main' into create_API_endpoint_for_proximityAnalysis

adf0f5d

Proximity Analysis API endpoint

0f8b7aa

This creates the Proximity Analysis API endpoint and a way to see all the analyses

A fix to make the key a string instead of Gender

4da0311

Create proximity_test.py

e4ee358

A manual test for proximity posting

Update views.py

191daa6

Fix unncessary result calculation if already done before

Update views.py

30ef395

joshfeli requested a review from MBJean July 22, 2021 23:37

joshfeli assigned farooqashar, joshfeli, Watermelanie, irinazoccolini and yaroluchko Jul 22, 2021

MBJean reviewed Jul 23, 2021

View reviewed changes

yaroluchko and others added 4 commits July 23, 2021 15:51

Test Case for proximity analysis object creation

e2c5448

Delete proximity_test.py

2130b24

Altered import statement

41382a6

`frequency.py` also has a `run_analysis` function; this change will prevent aliasing errors should the other team import the `frequency` counterpart into `views.py`.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create API endpoint for proximity analysis #53

Create API endpoint for proximity analysis #53

Uh oh!

yaroluchko commented Jul 22, 2021

Uh oh!

joshfeli commented Jul 22, 2021

Uh oh!

MBJean left a comment

Uh oh!

MBJean Jul 23, 2021

Uh oh!

MBJean Jul 23, 2021

Uh oh!

yaroluchko Jul 23, 2021

Uh oh!

yaroluchko Jul 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Create API endpoint for proximity analysis #53

Are you sure you want to change the base?

Create API endpoint for proximity analysis #53

Uh oh!

Conversation

yaroluchko commented Jul 22, 2021

Uh oh!

joshfeli commented Jul 22, 2021

Uh oh!

MBJean left a comment

Choose a reason for hiding this comment

Uh oh!

MBJean Jul 23, 2021

Choose a reason for hiding this comment

Uh oh!

MBJean Jul 23, 2021

Choose a reason for hiding this comment

Uh oh!

yaroluchko Jul 23, 2021

Choose a reason for hiding this comment

Uh oh!

yaroluchko Jul 23, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants