Comments (12)
ok I think this task is now done. I will open new ones for the metrics.rst
, engines.rst
and handlers.rst
package references.
Once these are done I think we're ready to release 0.1
from ignite.
I think we need to cover a few things:
- An overview of the event system
- Defining your own event handlers
- An overview of the metrics API
These files were put in as a stub initially, but if you fancy making a start on this feel free to re-arrange/delete as you see fit.
cc @jasonkriss in case he had some thoughts around this
from ignite.
Agreed with @alykhantejani. The way I had envisioned this and stubbed it out is to have a "Concepts" note that has the 3 things @alykhantejani mentioned. And then a "Quickstart" guide that just gives a barebones run through of getting a project up and running. The other .rst files will be filled in with autodoc
but we certainly may want to add some additional context to each one at the top before the actual autodoc
parts.
That being said, this can definitely change if you wanna get started on it and prefer a different arrangement.
from ignite.
@vfdev-5 I think concepts.rst
is a good place for high-level overview of how to to use metrics but i think metrics.rst
is a good place to explain the Metric
API and what methods need to be implemented to create your own metrics.
from ignite.
@alykhantejani what do you think to write in these notes? Today we have empty files :
concepts.rst
engines.rst
exceptions.rst
handlers.rst
index.rst
metrics.rst
quickstart.rst
In pytorch similar notes cover some particular notions or best practices.
from ignite.
I see what you mean @alykhantejani @jasonkriss, I can start with "Quickstart".
What do we put in index.rst
or it will be filled with autodoc
? The file engineS.rst
probably become engine.rst
...
from ignite.
engines.rst
should still be engines
because of how we have structured the code. You shouldn't have to put anything in index.rst unless you really want to. You can just add stuff to quickstart.rst. That would be awesome!
from ignite.
@jasonkriss you can check the first version of quickstart here ;-)
from ignite.
@vfdev-5 That looks like a great start!
from ignite.
I think this is done now @vfdev-5 @jasonkriss? Let me know if you think this should still stay open
from ignite.
@alykhantejani following your comment there is missing:
- An overview of the metrics API
But I do not know where to put it : concepts.rst
or metrics.rst
(however metrics
is at Package Reference)
from ignite.
@alykhantejani and exceptions.rst
too or not ?
As there is a file ...
from ignite.
Related Issues (20)
- DATALOADER_STOP_ITERATION should not be triggered if `Engine.run(data=None, ...)`
- Fix failing CI HOT 2
- Fix failing CI on engine tests
- Mean Absolute Percentage Error (MAPE) HOT 6
- Add cosine similarity metric HOT 4
- Add python 3.12 to CI
- Too much memory was cost for eval and train HOT 2
- Calculation of FID metric made use of classification probabilities instead of feature vectors HOT 1
- Confused about Batch_size HOT 1
- Confused about Batch_size HOT 2
- Add optional arg `encoding = None` for `ignite.utils.setup_logger` HOT 5
- Run metrics calculation in a background process HOT 8
- INFO: Resuming from iteration for provided data will fetch data until required iteration ... HOT 3
- How should I use global_step_from_engine HOT 5
- `idist.initialize` fails in Slurm when using `--ntasks-per-gpu` HOT 6
- To exclude special attributes from causing `MetricsLambda` creation
- To introduce `MetricGroup` class HOT 1
- Twitter to X update on homepage of website. HOT 1
- Change "Follow us on Twitter" text to "Follow us on X" HOT 2
- Initialization of WandBLogger with `init=True` fails HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ignite.