Add how-to guide to analyse company coverage#9
Conversation
|
|
||
| ## Prerequisites | ||
|
|
||
| - Python 3.7+ |
There was a problem hiding this comment.
Even if the script works with a previous version, I think we should encourage people to use a more recent version and include that here. Something like:
- Python 3.7+ (We recommend 3.10+)
Or directly mention as a prerequisite Python 3.10+. Otherwise it looks like this script is outdated.
| @@ -0,0 +1,7 @@ | |||
| name,mic,ticker,isin,cusip,sedol,ravenpack_id,country,industry | |||
| Micron Technology Inc.,,,US5951121038,,,49BBBC,US,Semiconductors | |||
There was a problem hiding this comment.
We can replace these input files with only one
name,ravenpack_id
Apple Inc.,4A6F00
NVIDIA Corporation,52258B
`python| Micron Technology Inc.,,,US5951121038,,,49BBBC,US,Semiconductors | ||
| NVIDIA Corporation,,,,,2379504,E09E2B,US,Semiconductors | ||
| Figma Inc.,,,,316841105,,BA9E0C,US,Internet Services | ||
| Microsoft Corporation,XNAS,MSFT,,,,228D42,US,Software |
There was a problem hiding this comment.
Also this script doesn't care about public vs private companies so I would rename the default input file to just company_ids.csv and make a note saying that you can pass the files from the other how to guide
|
|
||
|
|
||
| def _coverage_fields(label: str) -> tuple[str, str]: | ||
| return f"distinct_documents_{label}", f"distinct_chunks_{label}" |
There was a problem hiding this comment.
It ends up being a very long name, what do you think about:
distinct_documents_XXX -> docs_XXX
distinct_chunks_XXX -> chunks_XXX
We can still mention the distinct word in the README
| ```csv | ||
| name,ravenpack_id | ||
| Apple Inc.,4A6F00 | ||
| NVIDIA Corporation,52258B |
There was a problem hiding this comment.
This is not nvidia ID, the RP id is: E09E2B
2 participants
No description provided.