Skip to content

[SC 8504] Define missing parameters in the capital markets notebook#314

Closed
AnilSorathiya wants to merge 66 commits intoprodfrom
anilsorathiya/sc-8504/define-missing-parameters-in-the-capital-markets-notebook
Closed

[SC 8504] Define missing parameters in the capital markets notebook#314
AnilSorathiya wants to merge 66 commits intoprodfrom
anilsorathiya/sc-8504/define-missing-parameters-in-the-capital-markets-notebook

Conversation

@AnilSorathiya
Copy link
Contributor

@AnilSorathiya AnilSorathiya commented Feb 11, 2025

Internal Notes for Reviewers

  • Fix notebook quickstart_option_pricing_models.ipynb

johnwalz97 and others added 30 commits January 17, 2025 11:42
@johnwalz97
2.7.8
7eb6e20
@johnwalz97
feat: using backend to generate descriptions
d0fbdc9
@johnwalz97
Merge branch 'main' into john6797/sc-7670/move-test-result-descriptio…
de1af83 
…n-prompts-to-backend
@johnwalz97
2.8.0
18910dd
@johnwalz97
chore: get rid of prompts for test result description generation
f3cf871
@johnwalz97
Merge pull request #296 from validmind/john6797/sc-7670/move-test-res…
eb99068 
…ult-description-prompts-to-backend

John6797/sc 7670/move test result description prompts to backend
@github-actions
Generate docs
dbc1b3e
@johnwalz97
chore: remove rpy2 as a dependency
1b04e00
@johnwalz97
chore: update error messages for missing rpy2
24f6972
@johnwalz97
chore: running poetry lock
47af850
@johnwalz97
chore: remove unnecesary conversion of list to tuple
6e2a9b2
@johnwalz97
chore: removing unnecesary conversion of list to tuple
f6e7bba
@johnwalz97
chore: removing unnecesary conversion of list to tuple
78c76d3
@johnwalz97
chore: clean up
b33a583
@johnwalz97
chore: clean up
f99f1da
@johnwalz97
chore: clean up
55a226b
@johnwalz97
chore: organizing the main module exports better
0b93084
@johnwalz97
Merge pull request #298 from validmind/john6797/sc-8198/remove-rpy2-d…
6d6dab2 
…ependency

Remove `rpy2` Dependency
@github-actions
Generate docs
4791a82
@validbeck
+definition print_env() for developer reference (#299)
c471c06 
* +definition print_env() for developer reference

* Removed trailing whitespace

* 2.8.1
@github-actions
Generate docs
7f03a6e
@johnwalz97
2.8.2
86149da
@johnwalz97
feat: add regular background check to see if notebook kernel needs to…
a6ef59f 
… be restarted
@johnwalz97
chore: linter fix
b486c62
@johnwalz97
Merge pull request #300 from validmind/john6797/sc-8257/regularly-che…
cfbc2cf 
…ck-if-the-user-is-using-an-older

John6797/sc 8257/regularly check if the user is using an older
@github-actions
Generate docs
9935d8a
@juanmleng
Fix issue with storing embeddings
14a46f8
@juanmleng
Fix lint
aad7263
@juanmleng
2.8.3
fb64965
@juanmleng
Merge pull request #302 from validmind/juan5508/sc-8300/fix-store-emb…
a45706e 
…eddings-in-dictionary-instead-of-dataframe

[SC-8300] Fix: Store embeddings in dictionary instead of DataFrame
github-actions bot and others added 24 commits January 30, 2025 17:38
@github-actions
Generate docs
464050e
@validbeck
Forgot an end div omg (#305)
613e9f4 
* Forgot an end div omg

* 2.8.6
@github-actions
Generate docs
c7d59b1
@johnwalz97
Merge branch 'main' into john6797/sc-8259/support-raw-data-aggregatio…
4c222b5 
…n-in-comparison
@johnwalz97
fix: fixing issue that arises when raw data is not present
d51c4da
@johnwalz97
chore: using high code instead of full suite notebook for time series…
44855d0 
… to test comparison tests better
@johnwalz97
2.8.7
ffcfcae
@johnwalz97
Merge pull request #304 from validmind/john6797/sc-8259/support-raw-d…
732bd0f 
…ata-aggregation-in-comparison

Fix: Adding Missing `RawData` Support to Comparison Tests
@github-actions
Generate docs
ec304a9
@validbeck
Edited adding context to LLM-generated descriptions notebook (#307)
9f0274f 
* Drafting cleanup for adding context to LLM desc

* Edits to intro/title

* Edits up to setting context

* Tweaks

* Edits to setting up use case context

* Edits to examples

* Add ToC

* 2.8.8
@github-actions
Generate docs
7491546
@validbeck
Moved add context notebook to how_to (#308)
10ebc66 
* Moved add context notebook

* 2.8.9
@github-actions
Generate docs
8f924c7
@johnwalz97
feat: add new notebook and quick little update to how inspect preview…
1f2fc7e 
… is shown for raw data
@validbeck
Working branch for notebook edits
309faf5
@validbeck
Redid Setup section
5a27f32
@validbeck
Cleaning up 1st example
0fc7e4b
@validbeck
Setup for custom tests
4ab42b3
@validbeck
Adding ToC
8cfebe7
@validbeck
Final touches
f42b6e1
@validbeck
Merged notebooks & moved to how_to
571e488
@johnwalz97
Merge pull request #309 from validmind/john6797/sc-8282/documentation…
06175b6 
…-add-raw-data-to-validmind-library
@github-actions
Generate docs
dca8da2
@AnilSorathiya
Missing definition of the parameters in the capital markets model not…
58ea97f 
…ebook
@AnilSorathiya AnilSorathiya added bug Something isn't working internal Not to be externalized in the release notes labels Feb 11, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2025

PR Summary

This pull request introduces several changes to the documentation and installation instructions for the ValidMind Library. The primary changes include:

  1. R Installation Instructions: The installation instructions for R support have been updated. Instead of using the r-support extra, users are now instructed to install rpy2 directly. This change is reflected in the README.md, README.pypi.md, and other relevant documentation files.

  2. Documentation Enhancements: Various documentation files, including Jupyter notebooks, have been updated to improve clarity and provide more detailed instructions. This includes adding table of contents, improving section headers, and enhancing markdown formatting for better readability.

  3. Code and Functionality Updates: Minor updates to the codebase include changes to function signatures, such as adding a generate_descriptions parameter to the init function, and improvements to the handling of RawData objects in tests.

  4. Version Bump: The version of the ValidMind Library has been updated from 2.7.8 to 2.8.9 to reflect these changes.

  5. Dependency Updates: The poetry.lock file has been updated to reflect changes in dependencies, including the removal of rpy2 as an optional dependency and updates to other package versions.

Test Suggestions

  • Verify that the updated R installation instructions work as expected by following the new steps in a clean environment.
  • Run all updated Jupyter notebooks to ensure that the documentation changes do not introduce any errors.
  • Test the init function with the new generate_descriptions parameter to ensure it behaves as expected.
  • Check that the RawData handling in tests is functioning correctly and that the changes do not break existing functionality.
  • Ensure that the version bump is correctly reflected in all relevant files and that the library installs with the new version.

@AnilSorathiya AnilSorathiya deleted the anilsorathiya/sc-8504/define-missing-parameters-in-the-capital-markets-notebook branch February 11, 2025 23:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

bug Something isn't working internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@AnilSorathiya @johnwalz97 @validbeck @juanmleng