[docs] Add development setup notes for Census API #1111
Conversation
| - `cd` to the root of this repository | ||
| - `pip install -e api/python/cellxgene_census` | ||
| - To install dependencies needed to work on the [experimental](./src/cellxgene_census/experimental/) portion of the API: | ||
| `pip install -e api/python/cellxgene_census[experimental]`. |
There was a problem hiding this comment.
| `pip install -e api/python/cellxgene_census[experimental]`. | |
| `pip install -e 'api/python/cellxgene_census[experimental]'`. |
We can then remove the next line.
There was a problem hiding this comment.
Incorporated this suggestion
|
|
||
| - Learn more about the Census API by going through the tutorials in the [notebooks](../notebooks/) | ||
|
|
||
| ## Release |
There was a problem hiding this comment.
Not sure this belongs here. While the development setup can be useful for people who want to try the Census on their machine, this is only relevant for committers.
| # conditionally import torch, as it will not be available in all test environments | ||
| try: | ||
| from torch import Tensor, float32 | ||
| from torch import Tensor, float32 |
There was a problem hiding this comment.
TODO: remove this once we figure out the issue.
There was a problem hiding this comment.
Reset the commit hash to remove it
prathapsridharan
force-pushed
the
psridharan/census-dev-docs-1
branch
from
273081e to
e1f7817
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1111 +/- ##
=======================================
Coverage 91.12% 91.12%
=======================================
Files 77 77
Lines 5857 5857
=======================================
Hits 5337 5337
Misses 520 520
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
prathapsridharan
force-pushed
the
psridharan/census-dev-docs-1
branch
from
e1f7817 to
28ee420
Compare
This is one of a series of PRs to improve developer documentation for the Census repository as stated in #1109