https://github.com/fastai/fastcore

Python supercharged for the fastai library
https://github.com/fastai/fastcore

data-structures developer-tools dispatch documentation-generator fastai functional-programming languages parallel-processing python

Last synced: about 2 months ago
JSON representation

Python supercharged for the fastai library

• Host: GitHub
• URL: https://github.com/fastai/fastcore
• Owner: fastai
• License: apache-2.0
• Created: 2019-12-02T20:16:53.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-29T02:55:16.000Z (4 months ago)
• Last Synced: 2024-05-29T14:56:34.906Z (4 months ago)
• Topics: data-structures, developer-tools, dispatch, documentation-generator, fastai, functional-programming, languages, parallel-processing, python
• Language: Jupyter Notebook
• Homepage: http://fastcore.fast.ai
• Size: 7.09 MB
• Stars: 901
• Watchers: 19
• Forks: 262
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• best-of-python - GitHub - 8% open · ⏱️ 05.06.2024): (Others)

README

        
# Welcome to fastcore

Python is a powerful, dynamic language. Rather than bake everything into

the language, it lets the programmer customize it to make it work for

them. `fastcore` uses this flexibility to add to Python features

inspired by other languages we’ve loved, like multiple dispatch from

Julia, mixins from Ruby, and currying, binding, and more from Haskell.

It also adds some “missing features” and clean up some rough edges in

the Python standard library, such as simplifying parallel processing,

and bringing ideas from NumPy over to Python’s `list` type.

## Getting started

To install fastcore run: `conda install fastcore -c fastai` (if you use

Anaconda, which we recommend) or `pip install fastcore`. For an

[editable

install](https://stackoverflow.com/questions/35064426/when-would-the-e-editable-option-be-useful-with-pip-install),

clone this repo and run: `pip install -e ".[dev]"`. fastcore is tested

to work on Ubuntu, macOS and Windows (versions tested are those shown

with the `-latest` suffix

[here](https://docs.github.com/en/actions/reference/specifications-for-github-hosted-runners#supported-runners-and-hardware-resources)).

`fastcore` contains many features, including:

- `fastcore.test`: Simple testing functions

- `fastcore.foundation`: Mixins, delegation, composition, and more

- `fastcore.xtras`: Utility functions to help with functional-style

  programming, parallel processing, and more

- `fastcore.dispatch`: Multiple dispatch methods

- `fastcore.transform`: Pipelines of composed partially reversible

  transformations

To get started, we recommend you read through [the fastcore

tour](https://fastcore.fast.ai/tour.html).

## Contributing

After you clone this repository, please run `nbdev_install_hooks` in

your terminal. This sets up git hooks, which clean up the notebooks to

remove the extraneous stuff stored in the notebooks (e.g. which cells

you ran) which causes unnecessary merge conflicts.

To run the tests in parallel, launch `nbdev_test`.

Before submitting a PR, check that the local library and notebooks

match.

- If you made a change to the notebooks in one of the exported cells,

  you can export it to the library with `nbdev_prepare`.

- If you made a change to the library, you can export it back to the

  notebooks with `nbdev_update`.