Skip to content
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

New nb for scenarios + filestore #1109

Merged
merged 3 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/filestore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ CSV example:

fs = CSVFileStore("example.csv")
info = fs.push()
print(info) # to display the URL and Coop uuid of the stored file to use for retriving it later
print(info) # display the URL and Coop uuid of the stored file for retrieving it later


Example output:
Expand All @@ -54,7 +54,7 @@ PDF example:

fs = PDFFileStore("top_secret.pdf")
info = fs.push()
print(info) # to display the URL and Coop uuid of the stored file to use for retriving it later
print(info) # display the URL and Coop uuid of the stored file for retrieving it later


Example output:
Expand All @@ -77,7 +77,7 @@ PNG example:

fs = PNGFileStore("parrot_logo.png")
info = fs.push()
print(info) # to display the URL and Coop uuid of the stored file to use for retriving it later
print(info) # display the URL and Coop uuid of the stored file for retrieving it later


Example output:
Expand Down
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,13 @@ Technical Setup
- Create a :ref:`coop` to create, store and share content on the Expected Parrot server.
- :ref:`api_keys`: (*Optional*) Instructions for storing API keys for language models to use EDSL locally.


Getting Started
---------------

- :ref:`starter_tutorial`: A tutorial to help you get started using EDSL.


Core Concepts
-------------

Expand All @@ -60,6 +62,7 @@ Core Concepts
- :ref:`agents`: Design and implement AI agents to respond to surveys.
- :ref:`language_models`: Select language models to generate results.


Working with Results
--------------------

Expand All @@ -68,6 +71,7 @@ Working with Results
- :ref:`exceptions`: Identify and handle exceptions in your survey design.
- :ref:`token_usage`: Manage token limits for language models, and monitor and reduce token usage as desired.


Coop
----

Expand All @@ -78,6 +82,7 @@ Coop is a platform for creating, storing and sharing EDSL content and AI researc
- :ref:`remote_inference`: Use remote inference to run jobs on the Expected Parrot server.
- :ref:`notebooks`: Instructions for sharing `.ipynb` files with other users at the Coop.


Importing Data
--------------

Expand All @@ -88,6 +93,7 @@ Importing Data
* Extend your results with new questions and surveys
* Store and share your data on the Coop


How-to Guides
-------------

Expand All @@ -98,12 +104,14 @@ Examples of special methods and use cases for EDSL, including:
* Dynamic agent traits
* Creating new methods


Notebooks
---------

Templates and example code for using EDSL to conduct different kinds of research.
*We're happy to create a new notebook for your use case!*


Developers
----------

Expand Down Expand Up @@ -180,6 +188,7 @@ Information about additional functionality for developers.
notebooks/image_scenario_example.ipynb
notebooks/question_loop_scenario.ipynb
notebooks/scenario_list_wikipedia.ipynb
notebooks/scenarios_filestore_example.ipynb
notebooks/batching_results.ipynb
notebooks/adding_metadata.ipynb
notebooks/example_agent_dynamic_traits.ipynb
Expand Down
Loading
Loading