10000 Fix stuff in workflow docs by hintse · Pull Request #69 · Point72/ccflow · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix stuff in workflow docs #69

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 12, 2025
Merged

Fix stuff in workflow docs #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95eed73
Fix stuff in workflow docs. Change imports to ccflow. Fix Fizz Buzz h…
hintse May 12, 2025
bde9c1f
Add link to first steps page.
hintse May 12, 2025
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
2 changes: 1 addition & 1 deletion docs/wiki/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

## Pydantic for Configuration

Let's dive deeper into some of the ideas from the First Steps, focusing on how we leverage features of `pydantic` for the purposes of configuration.
Let's dive deeper into some of the ideas from the [First Steps](First-Steps), focusing on how we leverage features of `pydantic` for the purposes of configuration.

```python
from ccflow import BaseModel, ModelRegistry
Expand Down
6 changes: 3 additions & 3 deletions docs/wiki/Workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ print(GenericContext[str].model_validate(100))

```python
from datetime import date
from cubist_core.flow import (
from ccflow import (
DateContext,
DateRangeContext,
UniverseContext,
Expand Down Expand Up @@ -223,7 +223,7 @@ With the context and result types defined, we are now ready to define a workflow
Following the design objectives, and the exposition of how best to use configuration objects, we define a `CallableModel` abstract base class, which is essentially a configurable object where one must implement the `__call__` method as a function of the context. It has a few other features which we will explore below.
Note that since every CallableModel is a BaseModel, this class is configurable using all the configuration logic described in the Configuration Tutorial. In particular any workflow step can be named and added to the registry for later reference.

First, we illustrate a trivial example of defining a `CallableModel` that implements the "(FizzBuzz)[https://en.wikipedia.org/wiki/Fizz_buzz]" programming problem. operating on a `GenericContext` and returning a `GenericResult`
First, we illustrate a trivial example of defining a `CallableModel` that implements the "[FizzBuzz](https://en.wikipedia.org/wiki/Fizz_buzz)" programming problem. operating on a `GenericContext` and returning a `GenericResult`

```python
from ccflow import CallableModel, Flow, GenericResult, GenericContext
Expand Down Expand Up @@ -354,7 +354,7 @@ An example of the former is to change the log level for all model evaluations:
```python
import logging

from cubist_core.flow import FlowOptionsOverride
from ccflow import FlowOptionsOverride

logger = logging.getLogger()
logger.setLevel(logging.WARN)
Expand Down
0