Skip to content

Conversation

@habanoz
Copy link
Contributor

@habanoz habanoz commented Apr 17, 2024

This PR addresses issue #841.

  • Modify API documentation for class ChainOfThought to reflect the correct rationale_type according to the up-to-date source.
    • Provide a simple example to show how to specify a custom rationale
  • Modify API documentation for class ChainOfThoughtWithHint to reflect correct rationale_type according to the up-to-date source.

Also please note that git subtree pull command provided in docs/README.md does NOT work, raising fatal: refusing to merge unrelated histories.

@habanoz habanoz mentioned this pull request Apr 17, 2024
@habanoz habanoz changed the title fix rational type in the api documentation. fix #841, the issue with the api documentation. Apr 17, 2024
**Parameters:**
- `signature` (_Any_): Signature of predictive model.
- `rationale_type` (_dsp.Type_, _optional_): Rationale type for reasoning steps. Defaults to `None`.
- `rationale_type` (_dsp.OutputField_, _optional_): Rationale type for reasoning steps. Defaults to `None`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it should be dspy.OutputField

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point

Copy link
Contributor Author

@habanoz habanoz Apr 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed to dspy.

**Parameters:**
- `signature` (_Any_): Signature of predictive model.
- `rationale_type` (_dsp.Type_, _optional_): Rationale type for reasoning steps. Defaults to `None`.
- `rationale_type` (_dsp.OutputField_, _optional_): Rationale type for reasoning steps. Defaults to `None`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok.

Copy link
Contributor Author

@habanoz habanoz Apr 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed to dspy.

@habanoz habanoz requested a review from isaacbmiller April 25, 2024 08:50
@isaacbmiller isaacbmiller merged commit 66573d6 into stanfordnlp:main Apr 26, 2024
arnavsinghvi11 pushed a commit that referenced this pull request Jul 12, 2024
fix #841, the issue with the api documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants