-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
WIP Docs #272
WIP Docs #272
Commits on Dec 20, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 4fee372 - Browse repository at this point
Copy the full SHA 4fee372View commit details -
Configuration menu - View commit details
-
Copy full SHA for 15375b2 - Browse repository at this point
Copy the full SHA 15375b2View commit details -
Merge pull request #1 from darinkishore/sweep/add-sweep-config
Configure Sweep
Configuration menu - View commit details
-
Copy full SHA for 8d56c7c - Browse repository at this point
Copy the full SHA 8d56c7cView commit details -
Configuration menu - View commit details
-
Copy full SHA for deaba87 - Browse repository at this point
Copy the full SHA deaba87View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5da350b - Browse repository at this point
Copy the full SHA 5da350bView commit details -
Configuration menu - View commit details
-
Copy full SHA for bf1169e - Browse repository at this point
Copy the full SHA bf1169eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 011593c - Browse repository at this point
Copy the full SHA 011593cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 5a06559 - Browse repository at this point
Copy the full SHA 5a06559View commit details -
Configuration menu - View commit details
-
Copy full SHA for faeb6dc - Browse repository at this point
Copy the full SHA faeb6dcView commit details -
Configuration menu - View commit details
-
Copy full SHA for c54a118 - Browse repository at this point
Copy the full SHA c54a118View commit details -
Configuration menu - View commit details
-
Copy full SHA for 526e993 - Browse repository at this point
Copy the full SHA 526e993View commit details -
Configuration menu - View commit details
-
Copy full SHA for 735516c - Browse repository at this point
Copy the full SHA 735516cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 62d69ad - Browse repository at this point
Copy the full SHA 62d69adView commit details -
Configuration menu - View commit details
-
Copy full SHA for 8b7b1b2 - Browse repository at this point
Copy the full SHA 8b7b1b2View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9552a01 - Browse repository at this point
Copy the full SHA 9552a01View commit details -
Configuration menu - View commit details
-
Copy full SHA for 479c73d - Browse repository at this point
Copy the full SHA 479c73dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1da26f4 - Browse repository at this point
Copy the full SHA 1da26f4View commit details -
Configuration menu - View commit details
-
Copy full SHA for a9591d4 - Browse repository at this point
Copy the full SHA a9591d4View commit details -
Merge pull request #4 from darinkishore/sweep/set_up_project_for_read…
…thedocs_integrati Sweep: Set up project for ReadTheDocs integration. (✓ Sandbox Passed)
Configuration menu - View commit details
-
Copy full SHA for 3817d12 - Browse repository at this point
Copy the full SHA 3817d12View commit details -
Configuration menu - View commit details
-
Copy full SHA for e765bf2 - Browse repository at this point
Copy the full SHA e765bf2View commit details -
Configuration menu - View commit details
-
Copy full SHA for c733b0f - Browse repository at this point
Copy the full SHA c733b0fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 46d3cc4 - Browse repository at this point
Copy the full SHA 46d3cc4View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7ded89d - Browse repository at this point
Copy the full SHA 7ded89dView commit details -
Configuration menu - View commit details
-
Copy full SHA for f7a6d17 - Browse repository at this point
Copy the full SHA f7a6d17View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9360135 - Browse repository at this point
Copy the full SHA 9360135View commit details -
Configuration menu - View commit details
-
Copy full SHA for 64b874e - Browse repository at this point
Copy the full SHA 64b874eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 108e140 - Browse repository at this point
Copy the full SHA 108e140View commit details -
Configuration menu - View commit details
-
Copy full SHA for b1601d6 - Browse repository at this point
Copy the full SHA b1601d6View commit details -
Configuration menu - View commit details
-
Copy full SHA for d0a3735 - Browse repository at this point
Copy the full SHA d0a3735View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1250e38 - Browse repository at this point
Copy the full SHA 1250e38View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4f9c502 - Browse repository at this point
Copy the full SHA 4f9c502View commit details -
Configuration menu - View commit details
-
Copy full SHA for c6f5b3e - Browse repository at this point
Copy the full SHA c6f5b3eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 4a48c9c - Browse repository at this point
Copy the full SHA 4a48c9cView commit details -
Configuration menu - View commit details
-
Copy full SHA for d502b97 - Browse repository at this point
Copy the full SHA d502b97View commit details -
Configuration menu - View commit details
-
Copy full SHA for f7e1e9d - Browse repository at this point
Copy the full SHA f7e1e9dView commit details -
Configuration menu - View commit details
-
Copy full SHA for bf5dbdd - Browse repository at this point
Copy the full SHA bf5dbddView commit details -
Merge pull request #6 from darinkishore/sweep/update-docs
Update Documentation to Reflect Code Changes
Configuration menu - View commit details
-
Copy full SHA for 6a14181 - Browse repository at this point
Copy the full SHA 6a14181View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5c7fee7 - Browse repository at this point
Copy the full SHA 5c7fee7View commit details -
Configuration menu - View commit details
-
Copy full SHA for 406cacf - Browse repository at this point
Copy the full SHA 406cacfView commit details -
Merge pull request #11 from darinkishore/sweep/set_up_readthedocs_doc…
…umentation Sweep: Set up ReadTheDocs Documentation (✓ Sandbox Passed)
Configuration menu - View commit details
-
Copy full SHA for d40f4f8 - Browse repository at this point
Copy the full SHA d40f4f8View commit details -
Configuration menu - View commit details
-
Copy full SHA for 48d0e9b - Browse repository at this point
Copy the full SHA 48d0e9bView commit details
Commits on Dec 21, 2023
-
Refactor documentation structure
Refactored the documentation structure to move conf.py, index.rst, and other files to the 'docs/source' directory. Updated the '.gitignore' file to ignore the 'docs/doctrees' and 'docs/html' directories.
Configuration menu - View commit details
-
Copy full SHA for b4688a0 - Browse repository at this point
Copy the full SHA b4688a0View commit details -
Configuration menu - View commit details
-
Copy full SHA for 480e8da - Browse repository at this point
Copy the full SHA 480e8daView commit details -
Configuration menu - View commit details
-
Copy full SHA for 873fea3 - Browse repository at this point
Copy the full SHA 873fea3View commit details -
Added /docs/doctrees/ and /docs/html/ to .gitignore
Configuration menu - View commit details
-
Copy full SHA for adbdca5 - Browse repository at this point
Copy the full SHA adbdca5View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7c3afe0 - Browse repository at this point
Copy the full SHA 7c3afe0View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7df2cf3 - Browse repository at this point
Copy the full SHA 7df2cf3View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9697869 - Browse repository at this point
Copy the full SHA 9697869View commit details -
aider: Set the root path of the project to the correct directory for …
…Read the Docs (RTD). # Aider chat conversation: USER: Is the config for rtd using the right root path ? ASSISTANT: To determine if the configuration for Read the Docs (RTD) is using the correct root path, we need to consider the typical structure of a Python project and how RTD builds the documentation. The `os.path.abspath('../dspy/')` line is intended to add the directory containing the module/package `dspy` to the system path so that Sphinx can import the modules for documentation. If the `docs` directory is at the same level as the `dspy` directory, the current configuration is incorrect because `..` would refer to the parent directory of `docs`, not the sibling directory. The correct path should be `os.path.abspath('../../dspy/')` to go up two levels from `docs/source` to the root of the project and then into the `dspy` directory. Here is the diff to correct the root path: ```diff --- docs/source/conf.py +++ docs/source/conf.py @@ ... @@ # Set the root path of the project -sys.path.insert(0, os.path.abspath('../dspy/')) +sys.path.insert(0, os.path.abspath('../../dspy/')) ``` This change assumes that the `dspy` directory is a sibling of the `docs` directory and that the `conf.py` file is located in `docs/source`. If the directory structure is different, please provide the correct structure so I can adjust the path accordingly.
Configuration menu - View commit details
-
Copy full SHA for 0f8111e - Browse repository at this point
Copy the full SHA 0f8111eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 2b3c0ce - Browse repository at this point
Copy the full SHA 2b3c0ceView commit details -
Update the index.rst file with new content and images.
Configuration menu - View commit details
-
Copy full SHA for dfdc664 - Browse repository at this point
Copy the full SHA dfdc664View commit details -
Configuration menu - View commit details
-
Copy full SHA for ac10079 - Browse repository at this point
Copy the full SHA ac10079View commit details -
Configuration menu - View commit details
-
Copy full SHA for 2081c14 - Browse repository at this point
Copy the full SHA 2081c14View commit details -
Merge pull request #15 from darinkishore/sweep/issue-removal-duplicat…
…e-code Remove duplicate code block in Predict class
Configuration menu - View commit details
-
Copy full SHA for dac7427 - Browse repository at this point
Copy the full SHA dac7427View commit details -
Configuration menu - View commit details
-
Copy full SHA for 796d88a - Browse repository at this point
Copy the full SHA 796d88aView commit details -
Configuration menu - View commit details
-
Copy full SHA for adab66a - Browse repository at this point
Copy the full SHA adab66aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1aba982 - Browse repository at this point
Copy the full SHA 1aba982View commit details -
Configuration menu - View commit details
-
Copy full SHA for e3c5950 - Browse repository at this point
Copy the full SHA e3c5950View commit details -
Configuration menu - View commit details
-
Copy full SHA for 13cf3d8 - Browse repository at this point
Copy the full SHA 13cf3d8View commit details -
Merge pull request #27 from darinkishore/sweep/refactor_indexrst_to_d…
…raw_from_the_new_r_1 Sweep: Refactor index.rst to draw from the new `*.rst` converted documentation (✓ Sandbox Passed)
Configuration menu - View commit details
-
Copy full SHA for 230e01c - Browse repository at this point
Copy the full SHA 230e01cView commit details -
Update documentation and tutorial notebook with examples
This commit updates the docs README and main documentation with clearer examples and explanations. It also adds a new introductory tutorial notebook for DSPy. All descriptions of how to use DSPy, including setting up language and retrieval models and constructing DSPy programs, are now fleshed out with corresponding code examples for better understanding. A new detailed FAQ section has also been added to guide users about when to use DSPy and how it compares to other libraries.
Configuration menu - View commit details
-
Copy full SHA for 232b421 - Browse repository at this point
Copy the full SHA 232b421View commit details -
Configuration menu - View commit details
-
Copy full SHA for a18ce01 - Browse repository at this point
Copy the full SHA a18ce01View commit details -
Merge pull request #30 from darinkishore/sweep/revise_docsreadmerst_f…
…or_leftover_html_t Sweep: Revise `docs/README.rst` for leftover HTML tags, and other syntax issues. (✓ Sandbox Passed)
Configuration menu - View commit details
-
Copy full SHA for 982498c - Browse repository at this point
Copy the full SHA 982498cView commit details -
Configuration menu - View commit details
-
Copy full SHA for f2f9050 - Browse repository at this point
Copy the full SHA f2f9050View commit details -
Configuration menu - View commit details
-
Copy full SHA for 22fc826 - Browse repository at this point
Copy the full SHA 22fc826View commit details -
Configuration menu - View commit details
-
Copy full SHA for f08893d - Browse repository at this point
Copy the full SHA f08893dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 528191b - Browse repository at this point
Copy the full SHA 528191bView commit details
Commits on Dec 22, 2023
-
feat(docs): add initial documentation files and structure
This commit adds the initial documentation files and structure for the DSPy project. The documentation is written using Sphinx and reStructuredText format. The documentation includes sections for language model clients, retrieval model clients, teleprompters, using local models, and modules. These sections provide an overview of the different components of DSPy and how to use them. The documentation also includes an image representing DSPy and a conclusion section. This is the initial commit for the documentation and more content will be added in future commits.
Configuration menu - View commit details
-
Copy full SHA for 642efe5 - Browse repository at this point
Copy the full SHA 642efe5View commit details -
Configuration menu - View commit details
-
Copy full SHA for fd2a94e - Browse repository at this point
Copy the full SHA fd2a94eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 6aa6f03 - Browse repository at this point
Copy the full SHA 6aa6f03View commit details -
Configuration menu - View commit details
-
Copy full SHA for 247309e - Browse repository at this point
Copy the full SHA 247309eView commit details -
Merge pull request #38 from darinkishore/sweep/update_cloned_document…
…ation_from_llamain Sweep: Update cloned documentation from llama-index to document DSPy (✓ Sandbox Passed)
Configuration menu - View commit details
-
Copy full SHA for 68d98be - Browse repository at this point
Copy the full SHA 68d98beView commit details -
Configuration menu - View commit details
-
Copy full SHA for fd54518 - Browse repository at this point
Copy the full SHA fd54518View commit details -
chore(.readthedocs.yaml): update Sphinx configuration path from "docs…
…/source/conf.py" to "docs/conf.py" to match actual file location
Configuration menu - View commit details
-
Copy full SHA for c7a522a - Browse repository at this point
Copy the full SHA c7a522aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 8ee1fbc - Browse repository at this point
Copy the full SHA 8ee1fbcView commit details -
Configuration menu - View commit details
-
Copy full SHA for 345885f - Browse repository at this point
Copy the full SHA 345885fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 645444c - Browse repository at this point
Copy the full SHA 645444cView commit details -
Merge pull request #55 from darinkishore/sweep/add_documentation_for_…
…assertions_in_dspy Sweep: Add documentation for `Assertions`, in `dspy/assert`.
Configuration menu - View commit details
-
Copy full SHA for c539479 - Browse repository at this point
Copy the full SHA c539479View commit details -
Configuration menu - View commit details
-
Copy full SHA for d625b58 - Browse repository at this point
Copy the full SHA d625b58View commit details -
Merge pull request #54 from darinkishore/sweep/ensure_signatures_in_t…
…he_dspy_folder_has Sweep: Ensure `signatures` in the `dspy/` folder has documentation. (✓ Sandbox Passed)
Configuration menu - View commit details
-
Copy full SHA for 2be7cfa - Browse repository at this point
Copy the full SHA 2be7cfaView commit details -
Configuration menu - View commit details
-
Copy full SHA for 94d03ce - Browse repository at this point
Copy the full SHA 94d03ceView commit details -
Configuration menu - View commit details
-
Copy full SHA for 135dc58 - Browse repository at this point
Copy the full SHA 135dc58View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1f1e8d4 - Browse repository at this point
Copy the full SHA 1f1e8d4View commit details -
Configuration menu - View commit details
-
Copy full SHA for 8a65953 - Browse repository at this point
Copy the full SHA 8a65953View commit details -
Configuration menu - View commit details
-
Copy full SHA for 2edbec9 - Browse repository at this point
Copy the full SHA 2edbec9View commit details
Commits on Dec 23, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 942bc83 - Browse repository at this point
Copy the full SHA 942bc83View commit details -
Configuration menu - View commit details
-
Copy full SHA for 864695e - Browse repository at this point
Copy the full SHA 864695eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 3332b6a - Browse repository at this point
Copy the full SHA 3332b6aView commit details -
Configuration menu - View commit details
-
Copy full SHA for bd7a12d - Browse repository at this point
Copy the full SHA bd7a12dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 46e1936 - Browse repository at this point
Copy the full SHA 46e1936View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4b3f914 - Browse repository at this point
Copy the full SHA 4b3f914View commit details
Commits on Jan 6, 2024
-
Remove Algolia CSS and update documentation structure
The Algolia CSS file was removed, impacting the configuration file as well. Moreover, the documentation's structure was heavily updated, removing unnecessary sections and refining existing ones for clarity. Sections related to community and contributions are emphasized now. The standardization of the table of contents and captions was also a prominent part of the update.
Configuration menu - View commit details
-
Copy full SHA for 3d936d7 - Browse repository at this point
Copy the full SHA 3d936d7View commit details -
Configuration menu - View commit details
-
Copy full SHA for 48537ca - Browse repository at this point
Copy the full SHA 48537caView commit details -
The README.rst file is deleted and modules.ipynb file, which explains the use of DSPy modules, is created. The README was removed because the same information was already found in other files, resulting in duplication. The newly added file provides a detailed explanation about the DSPy modules.
Configuration menu - View commit details
-
Copy full SHA for 20b3226 - Browse repository at this point
Copy the full SHA 20b3226View commit details -
Refactor documentation structure and update file locations
The code refactor involves renaming and reorganizing the documentation and tutorial files from 'dspy_constructs' folders to 'guides' and 'api_reference' folders respectively. This makes the documentation more understandable and easier to navigate. In the process, redundant README files were also removed to eliminate unnecessary duplication.
Configuration menu - View commit details
-
Copy full SHA for 77ed808 - Browse repository at this point
Copy the full SHA 77ed808View commit details -
Configuration menu - View commit details
-
Copy full SHA for 098f3da - Browse repository at this point
Copy the full SHA 098f3daView commit details -
Update documentation structure and remove redundant README
The commit removes a redundant README file from the 'getting_started' folder and renames the existing README. The documentation structure has also been adjusted, moving files from 'getting_started' to 'guides' and 'api_reference', enhancing clarity and usability.
Configuration menu - View commit details
-
Copy full SHA for 29c807e - Browse repository at this point
Copy the full SHA 29c807eView commit details -
Configuration menu - View commit details
-
Copy full SHA for c2f9d64 - Browse repository at this point
Copy the full SHA c2f9d64View commit details -
feat(assertions.ipynb): add guide for DSPy Assertions
fix(index.rst): update link to Getting Started Guide in index.rst
Configuration menu - View commit details
-
Copy full SHA for 89a5a8d - Browse repository at this point
Copy the full SHA 89a5a8dView commit details
Commits on Jan 7, 2024
-
feat(docs): update index.rst to remove language model clients and add…
… assertions guide
Configuration menu - View commit details
-
Copy full SHA for b6b3939 - Browse repository at this point
Copy the full SHA b6b3939View commit details -
Remove redundant API reference documents from language models.
This commit removes two `anyscale.md` and `cohere.md` files from the `docs/api_reference/language_models/hosted` directory and `intro.ipynb` file from the 'getting_started/beginner' directory. These files were causing redundancy in the API reference documentation.
Configuration menu - View commit details
-
Copy full SHA for e4d2097 - Browse repository at this point
Copy the full SHA e4d2097View commit details -
Configuration menu - View commit details
-
Copy full SHA for 50ce9b4 - Browse repository at this point
Copy the full SHA 50ce9b4View commit details -
docs(conf.py): comment out hoverxref.extension to disable hover featu…
…re temporarily docs(Retrieve.md): delete Retrieve.md file as it is no longer needed
Configuration menu - View commit details
-
Copy full SHA for 27d577b - Browse repository at this point
Copy the full SHA 27d577bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 40e6bb8 - Browse repository at this point
Copy the full SHA 40e6bb8View commit details -
Remove multiple language model guide files
This commit eliminates five language model guide docs and makes necessary adjustments to the '.gitignore' file. The redundant documents were relating to the launching of MLP, TGI, and vLLM servers, as well as metrics and retrieval models. This streamlines the project's documentation structure for clarity.
Configuration menu - View commit details
-
Copy full SHA for 9e9b71a - Browse repository at this point
Copy the full SHA 9e9b71aView commit details -
docs(api_reference/modules): update module names and headers to match…
… the new naming convention docs(api_reference/modules): remove unnecessary sections and examples docs(api_reference/modules): add TODO comment to indicate that further changes are needed docs(index.rst): update path to tutorials docs(tutorials/tuts.md): create new file with introductory text for tutorials
Configuration menu - View commit details
-
Copy full SHA for dcc65e2 - Browse repository at this point
Copy the full SHA dcc65e2View commit details
Commits on Jan 12, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 336efcb - Browse repository at this point
Copy the full SHA 336efcbView commit details -
Configuration menu - View commit details
-
Copy full SHA for 97b7e2b - Browse repository at this point
Copy the full SHA 97b7e2bView commit details
Commits on Jan 14, 2024
-
Configuration menu - View commit details
-
Copy full SHA for b192794 - Browse repository at this point
Copy the full SHA b192794View commit details